From f7ced71f7cc4275183f7671a31c145cb6bc226cd Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Sat, 13 Nov 2021 07:41:56 -0600 Subject: [PATCH] =?UTF-8?q?feat(dir-swagger):=20=E2=9C=A8=20surface=20XML?= =?UTF-8?q?=20comments=20from=20Contracts=20&=20Application=20models?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...FilterLists.Directory.Api.Contracts.csproj | 1 + .../SwaggerConfigurationExtensions.cs | 36 +++++++++++-------- .../FilterLists.Directory.Application.csproj | 1 + 3 files changed, 23 insertions(+), 15 deletions(-) diff --git a/services/Directory/FilterLists.Directory.Api.Contracts/FilterLists.Directory.Api.Contracts.csproj b/services/Directory/FilterLists.Directory.Api.Contracts/FilterLists.Directory.Api.Contracts.csproj index d28c40860..fc256ccae 100644 --- a/services/Directory/FilterLists.Directory.Api.Contracts/FilterLists.Directory.Api.Contracts.csproj +++ b/services/Directory/FilterLists.Directory.Api.Contracts/FilterLists.Directory.Api.Contracts.csproj @@ -4,6 +4,7 @@ net6.0 enable enable + true diff --git a/services/Directory/FilterLists.Directory.Api/SwaggerConfigurationExtensions.cs b/services/Directory/FilterLists.Directory.Api/SwaggerConfigurationExtensions.cs index 6829174f8..eb6650cde 100644 --- a/services/Directory/FilterLists.Directory.Api/SwaggerConfigurationExtensions.cs +++ b/services/Directory/FilterLists.Directory.Api/SwaggerConfigurationExtensions.cs @@ -9,23 +9,29 @@ public static void AddSwaggerGen(this IServiceCollection services) { services.AddSwaggerGen(o => { - o.SwaggerDoc("v1", new OpenApiInfo - { - Title = "FilterLists Directory API", - Description = "An ASP.NET Core API serving the core FilterList information.", - Version = "v1", - //TermsOfService = "", - Contact = new OpenApiContact { Name = "FilterLists", Url = new Uri("https://filterlists.com") }, - License = new OpenApiLicense + o.SwaggerDoc("v1", + new OpenApiInfo { - Name = "MIT License", - Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/master/LICENSE") - } - }); + Title = "FilterLists Directory API", + Description = "An ASP.NET Core API serving the core FilterList information.", + Version = "v1", + //TermsOfService = "", + Contact = new OpenApiContact { Name = "FilterLists", Url = new Uri("https://filterlists.com") }, + License = new OpenApiLicense + { + Name = "MIT License", + Url = new Uri("https://github.com/collinbarrett/FilterLists/blob/master/LICENSE") + } + }); - var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; - var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); - o.IncludeXmlComments(xmlPath); + var apiXmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; + o.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, apiXmlFile)); + + var apiContractsXmlFile = $"{typeof(Contracts.ConfigurationExtensions).Assembly.GetName().Name}.xml"; + o.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, apiContractsXmlFile)); + + var applicationXmlFile = $"{typeof(Application.ConfigurationExtensions).Assembly.GetName().Name}.xml"; + o.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, applicationXmlFile)); }); } diff --git a/services/Directory/FilterLists.Directory.Application/FilterLists.Directory.Application.csproj b/services/Directory/FilterLists.Directory.Application/FilterLists.Directory.Application.csproj index f89c39246..2c22c59bc 100644 --- a/services/Directory/FilterLists.Directory.Application/FilterLists.Directory.Application.csproj +++ b/services/Directory/FilterLists.Directory.Application/FilterLists.Directory.Application.csproj @@ -4,6 +4,7 @@ net6.0 enable enable + true