diff --git a/.github/README.md b/.github/README.md index 7825fc700..e31dd5556 100644 --- a/.github/README.md +++ b/.github/README.md @@ -14,7 +14,7 @@ FilterLists Web - Docker Image
A React & TypeScript UI built with Ant Design.

-

Directory API: Directory API +

Directory API: Directory API FilterLists Directory API - Azure DevOps builds FilterLists Directory API - Azure DevOps releases FilterLists Directory API - Docker Image diff --git a/services/directory/src/FilterLists.Directory.Api/FilterLists.Directory.Api.csproj b/services/directory/src/FilterLists.Directory.Api/FilterLists.Directory.Api.csproj index cc960cac4..42d261422 100644 --- a/services/directory/src/FilterLists.Directory.Api/FilterLists.Directory.Api.csproj +++ b/services/directory/src/FilterLists.Directory.Api/FilterLists.Directory.Api.csproj @@ -36,6 +36,7 @@ runtime; build; native; contentfiles; analyzers; buildtransitive + diff --git a/services/directory/src/FilterLists.Directory.Api/Startup.cs b/services/directory/src/FilterLists.Directory.Api/Startup.cs index a233757e4..137689c41 100644 --- a/services/directory/src/FilterLists.Directory.Api/Startup.cs +++ b/services/directory/src/FilterLists.Directory.Api/Startup.cs @@ -4,6 +4,7 @@ using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; +using Microsoft.OpenApi.Models; namespace FilterLists.Directory.Api { @@ -20,6 +21,8 @@ public void ConfigureServices(IServiceCollection services) { services.AddControllers() .AddJsonOptions(o => o.JsonSerializerOptions.IgnoreNullValues = true); + services.AddSwaggerGen(c => + c.SwaggerDoc("v1", new OpenApiInfo {Title = "FilterLists Directory API", Version = "v1"})); services.AddApplicationServices(Configuration); } @@ -27,6 +30,12 @@ public static void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) app.UseDeveloperExceptionPage(); + app.UseSwagger(); + app.UseSwaggerUI(c => + { + c.SwaggerEndpoint("swagger/v1/swagger.json", "FilterLists Directory API V1"); + c.RoutePrefix = string.Empty; + }); app.UseRouting(); app.UseEndpoints(e => { e.MapControllers(); }); } diff --git a/web/src/App.tsx b/web/src/App.tsx index bd1ab4c62..c8c5abcd3 100644 --- a/web/src/App.tsx +++ b/web/src/App.tsx @@ -136,7 +136,7 @@ const GitHub = () => ( const Api = () => (