Feature/pppp 1117 make apiexplorer optional

.gitignore

@@ -30,7 +30,7 @@ bld/
 #wwwroot/
 
 # Visual Studio 2017 auto generated files
-Generated\ Files/
+**/Generated/ 
 
 # MSTest test Results
 [Tt]est[Rr]esult*/

Dojo.OpenApiGenerator.TestWebApi/Dojo.OpenApiGenerator.TestWebApi.csproj

@@ -4,7 +4,7 @@
     <TargetFramework>net8.0</TargetFramework> 
     <!-- If you want to see genereted code, then please uncomment EmitCompilerGeneratedFiles and CompilerGeneratedFilesOutputPath blocks -->
     <!-- <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>  
-    <CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath> -->
+    <CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>-->
     <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
   </PropertyGroup>
 

Dojo.OpenApiGenerator.TestWebApi/autoApiGeneratorSettings.json

@@ -3,5 +3,6 @@
   "IncludeVersionParameterInActionSignature": false,
   "OpenApiSupportedVersionsExtension": "x-supported-api-versions",
   "DateTimeVersionFormat": "yyyy-MM-dd",
-  "ApiAuthorizationPoliciesExtension": "x-authorization-policies"
+  "ApiAuthorizationPoliciesExtension": "x-authorization-policies",
+  "GenerateApiExplorer": false
 }

Dojo.OpenApiGenerator/AutoApiGenerator.cs

@@ -63,8 +63,8 @@ public void Execute(GeneratorExecutionContext context)
                 _autoApiGeneratorSettings = AutoApiGeneratorSettings.GetAutoApiGeneratorSettings(_projectDir);
                 var projectNamespace = context.GetProjectDefaultNamespace();
                 var apisToOverride = new List<string>();
-            
-                GenerateApiConfiguratorSourceCode(context, projectNamespace);
+
+                GenerateApiConfiguratorSourceCode(context, projectNamespace, _autoApiGeneratorSettings.GenerateApiExplorer);
                 GenerateInheritedApiVersionAttributeSourceCode(context, projectNamespace);
                 GenerateApisSourceCode(context, apisToOverride, projectNamespace);  
             }
@@ -89,12 +89,12 @@ private void GenerateApisSourceCode(GeneratorExecutionContext context, ICollecti
             GenerateApiVersionsSourceCode(context, projectNamespace);
         }
 
-        private void GenerateApiConfiguratorSourceCode(GeneratorExecutionContext context, string projectNamespace)
+        private void GenerateApiConfiguratorSourceCode(GeneratorExecutionContext context, string projectNamespace, bool generateApiExplorer)
         {
             _apiConfiguratorTemplateString ??= Templates.ReadTemplate(Templates.ApiConfiguratorTemplate);
 
             const string fileName = "ApiConfigurator.g.cs";
-            var source = _stubbleBuilder.Render(_apiConfiguratorTemplateString, new BasicClass(projectNamespace));
+            var source = _stubbleBuilder.Render(_apiConfiguratorTemplateString, new BasicClass(projectNamespace, generateApiExplorer));
 
             context.AddSource(fileName, SourceText.From(source, Encoding.UTF8));
         }

Dojo.OpenApiGenerator/CodeTemplates/ApiConfiguratorTemplate.mustache

@@ -24,16 +24,19 @@ namespace {{ProjectNamespace}}.Generated.StartupConfiguration
             bool assumeDefaultVersionWhenUnspecified = true,
             bool reportApiVersions = true)
         {
-            services
+            var versioningBuilder = services
                 .AddApiVersioning(options =>
                 {
                     options.AssumeDefaultVersionWhenUnspecified = assumeDefaultVersionWhenUnspecified;
                     options.DefaultApiVersion = defaultVersion ?? ApiVersion.Default;
                     options.ApiVersionReader = versionReader ?? new HeaderApiVersionReader(versionHeaderName);
                     options.ReportApiVersions = reportApiVersions;
                 })
-                .AddMvc()
-                .AddApiExplorer();
+                .AddMvc();
+
+{{#GenerateApiExplorer}}
+            versioningBuilder.AddApiExplorer();
+{{/GenerateApiExplorer}}
 
             foreach (var apiVersion in ApiConstants.ApiVersions)
             {

Dojo.OpenApiGenerator/Configuration/AutoApiGeneratorSettings.cs

@@ -6,11 +6,17 @@ namespace Dojo.OpenApiGenerator.Configuration
     internal class AutoApiGeneratorSettings
     {
         public string VersionParameterName { get; set; }
+
         public bool IncludeVersionParameterInActionSignature { get; set; }
+
         public string OpenApiSupportedVersionsExtension { get; set; }
+
         public string DateTimeVersionFormat { get; set; }
+
         public string ApiAuthorizationPoliciesExtension { get; set; }
 
+        public bool GenerateApiExplorer { get; set; } = true;
+
         public static AutoApiGeneratorSettings GetAutoApiGeneratorSettings(string projectDir)
         {
             var settingFilePath = $"{projectDir}/{Constants.AutoApiGeneratorSettingsFile}";

Dojo.OpenApiGenerator/Models/BasicClass.cs

@@ -2,8 +2,11 @@
 {
     internal class BasicClass : BaseGeneratedCodeModel
     {
-        public BasicClass(string projectNamespace) : base(projectNamespace)
+        public BasicClass(string projectNamespace, bool generateApiExplorer = false) : base(projectNamespace)
         {
+            GenerateApiExplorer = generateApiExplorer;
         }
+
+        public bool GenerateApiExplorer { get; private set; }
     }
 }

Dojo.OpenApiGenerator/autoApiGeneratorSettings.json.sample

@@ -19,5 +19,7 @@
        "Sec2"
      ]
    */
-  "ApiAuthorizationPoliciesExtension": "x-authorization-policies"
+  "ApiAuthorizationPoliciesExtension": "x-authorization-policies",
+  /* This will prevent swagger open api explorer generation*/
+  "GenerateApiExplorer": false
 }