From 13db19857ecf7078858d8a1dce7d93618011dd07 Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Tue, 8 Sep 2020 07:03:59 -0500 Subject: [PATCH] =?UTF-8?q?feat(directory):=20=E2=9C=A8=20add=20more=20Swa?= =?UTF-8?q?gger=20config?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/FilterLists.Directory.Api/Startup.cs | 11 +---- .../SwaggerExtensions.cs | 44 +++++++++++++++++++ 2 files changed, 46 insertions(+), 9 deletions(-) create mode 100644 services/directory/src/FilterLists.Directory.Api/SwaggerExtensions.cs diff --git a/services/directory/src/FilterLists.Directory.Api/Startup.cs b/services/directory/src/FilterLists.Directory.Api/Startup.cs index 137689c41..1d6fd04d2 100644 --- a/services/directory/src/FilterLists.Directory.Api/Startup.cs +++ b/services/directory/src/FilterLists.Directory.Api/Startup.cs @@ -4,7 +4,6 @@ using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; -using Microsoft.OpenApi.Models; namespace FilterLists.Directory.Api { @@ -21,8 +20,7 @@ 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.AddSwaggerGen(); services.AddApplicationServices(Configuration); } @@ -30,14 +28,9 @@ 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(); }); + app.UseSwagger(); } } } \ No newline at end of file diff --git a/services/directory/src/FilterLists.Directory.Api/SwaggerExtensions.cs b/services/directory/src/FilterLists.Directory.Api/SwaggerExtensions.cs new file mode 100644 index 000000000..da553c453 --- /dev/null +++ b/services/directory/src/FilterLists.Directory.Api/SwaggerExtensions.cs @@ -0,0 +1,44 @@ +using System; +using Microsoft.AspNetCore.Builder; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.OpenApi.Models; + +namespace FilterLists.Directory.Api +{ + internal static class SwaggerExtensions + { + public static void AddSwaggerGen(this IServiceCollection services) + { + services.AddSwaggerGen(c => + c.SwaggerDoc("v1", new OpenApiInfo + { + Title = "FilterLists Directory API", + Description = + "FilterLists is the independent, comprehensive directory of filter and host lists for advertisements, trackers, malware, and annoyances.", + Version = "v1", + //TermsOfService = "", + Contact = new OpenApiContact + { + Name = "Collin M. Barrett", + Url = new Uri("https://collinmbarrett.com/contact/") + }, + License = new OpenApiLicense + { + Name = "MIT License", + Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/master/LICENSE") + } + })); + } + + public static void UseSwagger(this IApplicationBuilder app) + { + app.UseSwagger(o => o.RouteTemplate = "{documentName}/swagger.json"); + app.UseSwaggerUI(c => + { + c.SwaggerEndpoint("v1/swagger.json", "FilterLists Directory API V1"); + c.DocumentTitle = "FilterLists Directory API"; + c.RoutePrefix = string.Empty; + }); + } + } +} \ No newline at end of file