{"id":18382339,"url":"https://github.com/centeredge/shawarma.aspnetcore","last_synced_at":"2025-04-11T20:45:32.698Z","repository":{"id":49362004,"uuid":"193519265","full_name":"CenterEdge/Shawarma.AspNetCore","owner":"CenterEdge","description":"ASP.Net Core Middleware For Integrating With Shawarma","archived":false,"fork":false,"pushed_at":"2022-12-09T20:15:22.000Z","size":69,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-15T23:41:56.341Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CenterEdge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-24T14:15:40.000Z","updated_at":"2024-03-11T12:27:46.000Z","dependencies_parsed_at":"2023-01-25T16:10:18.572Z","dependency_job_id":null,"html_url":"https://github.com/CenterEdge/Shawarma.AspNetCore","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterEdge%2FShawarma.AspNetCore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterEdge%2FShawarma.AspNetCore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterEdge%2FShawarma.AspNetCore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterEdge%2FShawarma.AspNetCore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CenterEdge","download_url":"https://codeload.github.com/CenterEdge/Shawarma.AspNetCore/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248480225,"owners_count":21110935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T01:04:35.746Z","updated_at":"2025-04-11T20:45:32.638Z","avatar_url":"https://github.com/CenterEdge.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shawarma.AspNetCore\n\n[![Build Status](https://travis-ci.org/CenterEdge/Shawarma.AspNetCore.svg?branch=master)](https://travis-ci.org/CenterEdge/Shawarma.AspNetCore)\n[![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/Shawarma.AspNetCore.svg)](https://www.nuget.org/packages/Shawarma.AspNetCore)\n\nASP.NET Core middleware and service hosting library designed to interact with Shawarma. This allows\nbackground services, implemented similarly to [IHostedService](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-2.2\u0026tabs=visual-studio),\nto be started and stopped based on whether the application instance is live on a Kubernetes\nload balancer. This assists with blue/green deployments to Kubernetes, and ensures that\nold application instances stop background processing of things like message queues.\n\nFor more details about Shawarma, see \u003chttps://github.com/CenterEdge/shawarma\u003e.\n\n## Usage\n\n```cs\n// This is an example in Program.cs using the Minimal API approach\nusing Shawarma.AspNetCore;\nusing Shawarma.AspNetCore.Hosting;\n\nvar builder = WebApplication.CreateBuilder(args);\n\nbuilder.Services\n    .AddShawarmaHosting()\n    .AddShawarmaService\u003cTestService\u003e();\n\nvar app = builder.Build();\n\nif (app.Environment.IsDevelopment())\n{\n    app.UseDeveloperExceptionPage();\n}\n\napp.MapShawarma();\napp.MapGet(\"/\", () =\u003e \"Hello World!\");\n\nawait app.RunAsync();\n```\n\n```cs\n// Use this approach in Startup.cs if you are not using the Minimal API approach\npublic void ConfigureServices(IServiceCollection services)\n{\n    services\n        .AddRouting()\n        .AddShawarmaHosting()\n        // Add any IShawarmaService instances to be managed\n        .AddShawarmaService\u003cTestService\u003e();\n}\n\npublic void Configure(IApplicationBuilder app, IWebHostEnvironment env)\n{\n    if (env.IsDevelopment())\n    {\n        app.UseDeveloperExceptionPage();\n    }\n\n    app.UseRouting();\n    app.UseEndpoints(endpoints =\u003e\n    {\n        endpoints.MapShawarma();\n\n        endpoints.MapGet(\"\", async context =\u003e\n        {\n            await context.Response.WriteAsync(\"Hello World!\");\n        });\n    });\n}\n```\n\n```cs\npublic class TestService : GenericShawarmaService\n{\n    public TestService(ILogger\u003cTestService\u003e logger)\n        : base(logger)\n    {\n    }\n\n    protected override Task StartInternalAsync(CancellationToken cancellationToken)\n    {\n        // Start doing work here\n        return Task.CompletedTask;\n    }\n\n    protected override Task StopInternalAsync(CancellationToken cancellationToken)\n    {\n        // Stop doing work here\n        return Task.CompletedTask;\n    }\n}\n```\n\n## Older .NET Core Versions\n\nFor applications not using endpoint routing, middleware may be used instead. However, this approach\nis considered obsolete.\n\n```cs\npublic void Configure(IApplicationBuilder app, IHostingEnvironment env)\n{\n    if (env.IsDevelopment())\n    {\n        app.UseDeveloperExceptionPage();\n    }\n\n    // Add before MVC or other handlers\n    app.UseShawarma();\n\n    app.Run(async (context) =\u003e\n    {\n        await context.Response.WriteAsync(\"Hello World!\");\n    });\n}\n```\n\n## Developing\n\nSee [Developing Shawarma.AspNetCore](./Developing.md) for instructions for development.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcenteredge%2Fshawarma.aspnetcore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcenteredge%2Fshawarma.aspnetcore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcenteredge%2Fshawarma.aspnetcore/lists"}