Merge pull request #207 from atc-net/hotfix/maintenance

Maintenance

Author: perkops

src/Atc.Rest.ApiGenerator.Framework.Minimal/ContentGenerators/ContentGeneratorServerEndpoints.cs

@@ -35,13 +35,6 @@ public string Generate()
             sb.Append(codeDocumentationTagsGenerator.GenerateTags(0, parameters.DocumentationTags));
         }
 
-        if (parameters.Authorization is not null)
-        {
-            sb.AppendLine(parameters.Authorization.UseAllowAnonymous
-                ? "[AllowAnonymous]"
-                : "[Authorize]");
-        }
-
         sb.AppendLine(codeAttributeGenerator.Generate());
 
         sb.AppendLine($"public sealed class {parameters.ApiGroupName}EndpointDefinition : IEndpointDefinition");

src/Atc.Rest.ApiGenerator.Framework.Minimal/ContentGenerators/ContentGeneratorServerProgram.cs

@@ -70,6 +70,8 @@ public string Generate()
         sb.AppendLine();
         sb.AppendLine(8, "app.UseEndpointDefinitions();");
         sb.AppendLine();
+        sb.AppendLine(8, "app.MapGet(\"/\", () => TypedResults.Text(\"OK\", \"text/plain\")).ExcludeFromDescription();");
+        sb.AppendLine();
         sb.AppendLine(8, "app.UseGlobalErrorHandler();");
         sb.AppendLine();
         sb.AppendLine(8, "// Enabling the status code pages middleware, will allow Problem Details to be used in some extra non-exception related framework scenarios,");

src/Atc.Rest.ApiGenerator.Framework.Minimal/ContentGenerators/ContentGeneratorServerServiceCollectionExtensions.cs

@@ -22,29 +22,29 @@ public string Generate()
         sb.AppendLine(8, "this IServiceCollection services)");
         sb.AppendLine(4, "{");
         sb.AppendLine(8, "services.AddEndpointsApiExplorer();");
-        sb.AppendLine(8, "services.AddApiVersioning(");
-        sb.AppendLine(16, "options =>");
-        sb.AppendLine(16, "{");
-        sb.AppendLine(20, "// Specify the default API Version");
-        sb.AppendLine(20, "options.DefaultApiVersion = new ApiVersion(1, 0);");
+        sb.AppendLine(8, "services");
+        sb.AppendLine(12, ".AddApiVersioning(options =>");
+        sb.AppendLine(12, "{");
+        sb.AppendLine(16, "// Specify the default API Version");
+        sb.AppendLine(16, "options.DefaultApiVersion = new ApiVersion(1, 0);");
         sb.AppendLine();
-        sb.AppendLine(20, "// If the client hasn't specified the API version in the request, use the default API version number");
-        sb.AppendLine(20, "options.AssumeDefaultVersionWhenUnspecified = true;");
+        sb.AppendLine(16, "// If the client hasn't specified the API version in the request, use the default API version number");
+        sb.AppendLine(16, "options.AssumeDefaultVersionWhenUnspecified = true;");
         sb.AppendLine();
-        sb.AppendLine(20, "// reporting api versions will return the headers");
-        sb.AppendLine(20, "// \"api-supported-versions\" and \"api-deprecated-versions\"");
-        sb.AppendLine(20, "options.ReportApiVersions = true;");
+        sb.AppendLine(16, "// reporting api versions will return the headers");
+        sb.AppendLine(16, "// \"api-supported-versions\" and \"api-deprecated-versions\"");
+        sb.AppendLine(16, "options.ReportApiVersions = true;");
         sb.AppendLine();
-        sb.AppendLine(20, "//// DEFAULT Version reader is QueryStringApiVersionReader();");
-        sb.AppendLine(20, "//// clients request the specific version using the x-api-version header");
-        sb.AppendLine(20, "//// Supporting multiple versioning scheme");
-        sb.AppendLine(20, "options.ApiVersionReader = ApiVersionReader.Combine(");
-        sb.AppendLine(24, "new HeaderApiVersionReader(ApiVersionConstants.ApiVersionHeaderParameter),");
-        sb.AppendLine(24, "new MediaTypeApiVersionReader(ApiVersionConstants.ApiVersionMediaTypeParameter),");
-        sb.AppendLine(24, "new QueryStringApiVersionReader(ApiVersionConstants.ApiVersionQueryParameter),");
-        sb.AppendLine(24, "new QueryStringApiVersionReader(ApiVersionConstants.ApiVersionQueryParameterShort),");
-        sb.AppendLine(24, "new UrlSegmentApiVersionReader());");
-        sb.AppendLine(16, "})");
+        sb.AppendLine(16, "//// DEFAULT Version reader is QueryStringApiVersionReader();");
+        sb.AppendLine(16, "//// clients request the specific version using the x-api-version header");
+        sb.AppendLine(16, "//// Supporting multiple versioning scheme");
+        sb.AppendLine(16, "options.ApiVersionReader = ApiVersionReader.Combine(");
+        sb.AppendLine(20, "new HeaderApiVersionReader(ApiVersionConstants.ApiVersionHeaderParameter),");
+        sb.AppendLine(20, "new MediaTypeApiVersionReader(ApiVersionConstants.ApiVersionMediaTypeParameter),");
+        sb.AppendLine(20, "new QueryStringApiVersionReader(ApiVersionConstants.ApiVersionQueryParameter),");
+        sb.AppendLine(20, "new QueryStringApiVersionReader(ApiVersionConstants.ApiVersionQueryParameterShort),");
+        sb.AppendLine(20, "new UrlSegmentApiVersionReader());");
+        sb.AppendLine(12, "})");
         sb.AppendLine(12, ".AddApiExplorer(options =>");
         sb.AppendLine(12, "{");
         sb.AppendLine(16, "// add the versioned api explorer, which also adds IApiVersionDescriptionProvider service");
@@ -60,7 +60,8 @@ public string Generate()
         sb.AppendLine(4, "public static void ConfigureSwagger(");
         sb.AppendLine(8, "this IServiceCollection services)");
         sb.AppendLine(4, "{");
-        sb.AppendLine(8, "services.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();");
+        sb.AppendLine(8, "services.ConfigureOptions<ConfigureSwaggerDocOptions>();");
+        sb.AppendLine();
         sb.AppendLine(8, "services.AddSwaggerGen(options =>");
         sb.AppendLine(8, "{");
         sb.AppendLine(12, "options.OperationFilter<SwaggerDefaultValues>();");

src/Atc.Rest.ApiGenerator.Framework.Minimal/ContentGenerators/ContentGeneratorServeWebApplicationExtensions.cs renamed to src/Atc.Rest.ApiGenerator.Framework.Minimal/ContentGenerators/ContentGeneratorServerWebApplicationExtensions.cs

@@ -1,11 +1,11 @@
 // ReSharper disable SwitchStatementMissingSomeEnumCasesNoDefault
 namespace Atc.Rest.ApiGenerator.Framework.Minimal.ContentGenerators;
 
-public class ContentGeneratorServeWebApplicationExtensions : IContentGenerator
+public class ContentGeneratorServerWebApplicationExtensions : IContentGenerator
 {
     private readonly ContentGeneratorBaseParameters parameters;
 
-    public ContentGeneratorServeWebApplicationExtensions(
+    public ContentGeneratorServerWebApplicationExtensions(
         ContentGeneratorBaseParameters parameters)
     {
         this.parameters = parameters;
@@ -21,7 +21,7 @@ public string Generate()
         sb.AppendLine();
         sb.AppendLine("public static class WebApplicationExtensions");
         sb.AppendLine("{");
-        sb.AppendLine(4, "private static readonly string[] PatchHttpMethods = { \"patch\" };");
+        sb.AppendLine(4, "private static readonly string[] PatchHttpMethods = [\"patch\"];");
         sb.AppendLine();
         sb.AppendLine(4, "public static RouteHandlerBuilder MapPatch(");
         sb.AppendLine(8, "this WebApplication app,");
@@ -39,6 +39,11 @@ public string Generate()
             sb.AppendLine(8, "this WebApplication app,");
             sb.AppendLine(8, "string applicationName)");
             sb.AppendLine(4, "{");
+            sb.AppendLine(8, "if (!app.Environment.IsDevelopment())");
+            sb.AppendLine(8, "{");
+            sb.AppendLine(12, "return app;");
+            sb.AppendLine(8, "}");
+            sb.AppendLine();
             sb.AppendLine(8, "app.UseSwagger();");
             sb.AppendLine(8, "app.UseSwaggerUI(options =>");
             sb.AppendLine(8, "{");

src/Atc.Rest.ApiGenerator.Framework.Minimal/ProjectGenerator/ServerHostGenerator.cs

@@ -164,7 +164,7 @@ public void ScaffoldWebApplicationBuilderExtensions()
     public void ScaffoldWebApplicationExtensions(
         SwaggerThemeMode swaggerThemeMode)
     {
-        var contentGenerator = new ContentGenerators.ContentGeneratorServeWebApplicationExtensions(
+        var contentGenerator = new ContentGenerators.ContentGeneratorServerWebApplicationExtensions(
             new ContentGeneratorBaseParameters(Namespace: projectName))
         {
             SwaggerThemeMode = swaggerThemeMode,
@@ -181,29 +181,6 @@ public void ScaffoldWebApplicationExtensions(
             overrideIfExist: false);
     }
 
-    public void ScaffoldConfigureSwaggerOptions()
-    {
-        var fullNamespace = $"{projectName}";
-
-        var contentGeneratorServerSwaggerDocOptionsParameters = ContentGeneratorServerSwaggerDocOptionsParameterFactory
-            .Create(
-                fullNamespace,
-                openApiDocument.ToSwaggerDocOptionsParameters());
-
-        var contentGenerator = new ContentGeneratorServeConfigureSwaggerOptions(
-            contentGeneratorServerSwaggerDocOptionsParameters);
-
-        var content = contentGenerator.Generate();
-
-        var contentWriter = new ContentWriter(logger);
-        contentWriter.Write(
-            projectPath,
-            projectPath.CombineFileInfo("Options", "ConfigureSwaggerOptions.cs"),
-            ContentWriterArea.Src,
-            content,
-            overrideIfExist: false);
-    }
-
     public void ScaffoldProgramFile(
         SwaggerThemeMode swaggerThemeMode)
     {
@@ -251,7 +228,7 @@ public void GenerateConfigureSwaggerDocOptions()
                 fullNamespace,
                 openApiDocument.ToSwaggerDocOptionsParameters());
 
-        var contentGenerator = new ContentGeneratorServerSwaggerDocOptions(
+        var contentGenerator = new ContentGeneratorServerConfigureSwaggerDocOptions(
             new GeneratedCodeHeaderGenerator(new GeneratedCodeGeneratorParameters(apiGeneratorVersion)),
             new GeneratedCodeAttributeGenerator(new GeneratedCodeGeneratorParameters(apiGeneratorVersion)),
             contentGeneratorServerSwaggerDocOptionsParameters);

src/Atc.Rest.ApiGenerator.Framework.Mvc/ProjectGenerator/ServerHostGenerator.cs

@@ -124,29 +124,6 @@ public void ScaffoldWebApplicationExtensions(
         SwaggerThemeMode swaggerThemeMode)
         => throw new NotSupportedException($"{nameof(ScaffoldWebApplicationExtensions)} is not supported for MVC");
 
-    public void ScaffoldConfigureSwaggerOptions()
-    {
-        var fullNamespace = $"{projectName}";
-
-        var contentGeneratorServerSwaggerDocOptionsParameters = ContentGeneratorServerSwaggerDocOptionsParameterFactory
-            .Create(
-                fullNamespace,
-                openApiDocument.ToSwaggerDocOptionsParameters());
-
-        var contentGenerator = new ContentGeneratorServeConfigureSwaggerOptions(
-            contentGeneratorServerSwaggerDocOptionsParameters);
-
-        var content = contentGenerator.Generate();
-
-        var contentWriter = new ContentWriter(logger);
-        contentWriter.Write(
-            projectPath,
-            projectPath.CombineFileInfo("Options", "ConfigureSwaggerOptions.cs"),
-            ContentWriterArea.Src,
-            content,
-            overrideIfExist: false);
-    }
-
     public void ScaffoldProgramFile(
         SwaggerThemeMode swaggerThemeMode)
     {
@@ -204,7 +181,7 @@ public void GenerateConfigureSwaggerDocOptions()
                 fullNamespace,
                 openApiDocument.ToSwaggerDocOptionsParameters());
 
-        var contentGenerator = new ContentGeneratorServerSwaggerDocOptions(
+        var contentGenerator = new ContentGeneratorServerConfigureSwaggerDocOptions(
             new GeneratedCodeHeaderGenerator(new GeneratedCodeGeneratorParameters(apiGeneratorVersion)),
             new GeneratedCodeAttributeGenerator(new GeneratedCodeGeneratorParameters(apiGeneratorVersion)),
             contentGeneratorServerSwaggerDocOptionsParameters);

src/Atc.Rest.ApiGenerator.Framework/ContentGenerators/Server/ContentGeneratorServeConfigureSwaggerOptions.cs renamed to src/Atc.Rest.ApiGenerator.Framework/ContentGenerators/Server/ContentGeneratorServerConfigureSwaggerDocOptions.cs

@@ -1,50 +1,58 @@
 namespace Atc.Rest.ApiGenerator.Framework.ContentGenerators.Server;
 
-public class ContentGeneratorServeConfigureSwaggerOptions : IContentGenerator
+public sealed class ContentGeneratorServerConfigureSwaggerDocOptions : IContentGenerator
 {
+    private readonly GeneratedCodeHeaderGenerator codeHeaderGenerator;
+    private readonly GeneratedCodeAttributeGenerator codeAttributeGenerator;
     private readonly ContentGeneratorServerSwaggerDocOptionsParameters parameters;
 
-    public ContentGeneratorServeConfigureSwaggerOptions(
+    public ContentGeneratorServerConfigureSwaggerDocOptions(
+        GeneratedCodeHeaderGenerator codeHeaderGenerator,
+        GeneratedCodeAttributeGenerator codeAttributeGenerator,
         ContentGeneratorServerSwaggerDocOptionsParameters parameters)
     {
+        this.codeHeaderGenerator = codeHeaderGenerator;
+        this.codeAttributeGenerator = codeAttributeGenerator;
         this.parameters = parameters;
     }
 
     public string Generate()
     {
         var sb = new StringBuilder();
 
+        sb.Append(codeHeaderGenerator.Generate());
         sb.AppendLine($"namespace {parameters.Namespace}.Options;"); // TODO: Move to constant
         sb.AppendLine();
-        sb.AppendLine("public class ConfigureSwaggerOptions : IConfigureOptions<SwaggerGenOptions>");
+        sb.AppendLine(codeAttributeGenerator.Generate());
+        sb.AppendLine("public class ConfigureSwaggerDocOptions : IConfigureOptions<SwaggerGenOptions>");
         sb.AppendLine("{");
         sb.AppendLine(4, "private readonly IApiVersionDescriptionProvider provider;");
         sb.AppendLine(4, "private readonly IWebHostEnvironment environment;");
         sb.AppendLine();
         sb.AppendLine(4, "/// <summary>");
-        sb.AppendLine(4, "/// Initializes a new instance of the <see cref=\"ConfigureSwaggerOptions\"/> class.");
+        sb.AppendLine(4, "/// Initializes a new instance of the <see cref=\"ConfigureSwaggerDocOptions\"/> class.");
         sb.AppendLine(4, "/// </summary>");
         sb.AppendLine(4, "/// <param name=\"provider\">The <see cref=\"IApiVersionDescriptionProvider\">provider</see> used to generate Swagger documents.</param>");
         sb.AppendLine(4, "/// <param name=\"environment\">The environment.</param>");
-        sb.AppendLine(4, "public ConfigureSwaggerOptions(");
+        sb.AppendLine(4, "public ConfigureSwaggerDocOptions(");
         sb.AppendLine(8, "IApiVersionDescriptionProvider provider,");
         sb.AppendLine(8, "IWebHostEnvironment environment)");
         sb.AppendLine(4, "{");
         sb.AppendLine(8, "this.provider = provider;");
         sb.AppendLine(8, "this.environment = environment;");
         sb.AppendLine(4, "}");
         sb.AppendLine();
-        sb.AppendLine(4, "/// <inheritdoc />");
         sb.AppendLine(4, "public void Configure(");
         sb.AppendLine(8, "SwaggerGenOptions options)");
         sb.AppendLine(4, "{");
-        sb.AppendLine(8, "// Add a swagger document for each discovered API version");
-        sb.AppendLine(8, "// note: you might choose to skip or document deprecated API versions differently");
         sb.AppendLine(8, "foreach (var description in provider.ApiVersionDescriptions)");
         sb.AppendLine(8, "{");
         sb.AppendLine(12, "options.SwaggerDoc(description.GroupName, CreateInfoForApiVersion(description));");
         sb.AppendLine(8, "}");
+        sb.AppendLine();
+        sb.AppendLine(8, "options.IncludeXmlComments(Path.ChangeExtension(GetType().Assembly.Location, \"xml\"));");
         sb.AppendLine(4, "}");
+
         sb.AppendLine();
         sb.AppendLine(4, "private OpenApiInfo CreateInfoForApiVersion(");
         sb.AppendLine(8, "ApiVersionDescription description)");

src/Atc.Rest.ApiGenerator.Framework/ContentGenerators/Server/ContentGeneratorServerSwaggerDocOptions.cs

@@ -28,8 +28,6 @@ void ScaffoldWebApplicationExtensions(
 
     void GenerateConfigureSwaggerDocOptions();
 
-    void ScaffoldConfigureSwaggerOptions();
-
     void ScaffoldProgramFile(
         SwaggerThemeMode swaggerThemeMode);
 

src/Atc.Rest.ApiGenerator.Framework/ProjectGenerator/IServerHostGenerator.cs

@@ -28,7 +28,7 @@ public class NugetPackageReferenceProvider(
         { "Microsoft.NETCore.Platforms", "7.0.4" },
         { "Microsoft.NET.Test.Sdk", "17.10.0" },
         { "NSubstitute", "5.1.0" },
-        { "Swashbuckle.AspNetCore", "6.6.2" },
+        { "Swashbuckle.AspNetCore", "6.7.0" },
         { "xunit", "2.8.1" },
         { "xunit.runner.visualstudio", "2.8.1" },
     };