Add options to override gateway documentation title and openapi information (#247)

* added GatewayDocsTitle and OpenAPI information parameters to GenerateGatewayDocsItself method

* Updated readme

* Removed extra space

Co-authored-by: Kyle Estes <kestes@tigercommissary.com>

Author: Arcalise08

README.md

@@ -269,6 +269,12 @@ services.AddSwaggerForOcelot(Configuration,
       o.GenerateDocsForGatewayItSelf(opt =>
       {
           opt.FilePathsForXmlComments = { "MyAPI.xml" };
+          docGen.GatewayDocsTitle = "My Gateway";
+          docGen.GatewayDocsOpenApiInfo = new()
+          {
+             Title = "My Gateway",
+             Version = "v1",
+          };
           opt.DocumentFilter<MyDocumentFilter>();
           opt.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme()
           {

src/MMLib.SwaggerForOcelot/Configuration/OcelotGatewayItSelfSwaggerGenOptions.cs

@@ -27,6 +27,9 @@ public OcelotGatewayItSelfSwaggerGenOptions()
         /// </summary>
         public string[] FilePathsForXmlComments { get; set; }
 
+        public string? GatewayDocsTitle { get; set; }
+        public OpenApiInfo? GatewayDocsOpenApiInfo { get; set; }
+
         internal List<Action<SwaggerGenOptions>> DocumentFilterActions { get; }
 
         internal List<Action<SwaggerGenOptions>> OperationFilterActions { get; }

src/MMLib.SwaggerForOcelot/Configuration/OcelotSwaggerGenOptions.cs

@@ -33,9 +33,12 @@ public class OcelotSwaggerGenOptions
         public void GenerateDocsDocsForGatewayItSelf(Action<OcelotGatewayItSelfSwaggerGenOptions> options = null)
         {
             GenerateDocsForGatewayItSelf = true;
-
+           
             OcelotGatewayItSelfSwaggerGenOptions = new OcelotGatewayItSelfSwaggerGenOptions();
             options?.Invoke(OcelotGatewayItSelfSwaggerGenOptions);
+
+            GatewayDocsTitle = OcelotGatewayItSelfSwaggerGenOptions.GatewayDocsTitle ?? GatewayDocsTitle;
+            GatewayDocsOpenApiInfo = OcelotGatewayItSelfSwaggerGenOptions.GatewayDocsOpenApiInfo ?? GatewayDocsOpenApiInfo;
         }
 
         /// <summary>
@@ -61,6 +64,14 @@ public void AddAuthenticationProviderKeyMapping(string authenticationProviderKey
 
         internal const string GatewayKey = "gateway";
 
+        internal string GatewayDocsTitle { get; set; } = "Gateway";
+
+        internal OpenApiInfo GatewayDocsOpenApiInfo { get; set; } = new()
+        {
+            Title = "Gateway",
+            Version = GatewayKey,
+        };
+
         internal OcelotGatewayItSelfSwaggerGenOptions OcelotGatewayItSelfSwaggerGenOptions { get; private set; }
 
         internal Dictionary<string, string> AuthenticationProviderKeyMap { get; } = new();

src/MMLib.SwaggerForOcelot/DependencyInjection/ServiceCollectionExtensions.cs

@@ -85,11 +85,7 @@ private static void AddGatewayItSelfDocs(SwaggerGenOptions c, OcelotSwaggerGenOp
         {
             if (options.GenerateDocsForGatewayItSelf)
             {
-                c.SwaggerDoc(OcelotSwaggerGenOptions.GatewayKey, new OpenApiInfo
-                {
-                    Title =  "Gateway",
-                    Version = OcelotSwaggerGenOptions.GatewayKey,
-                });
+                c.SwaggerDoc(OcelotSwaggerGenOptions.GatewayKey, options.GatewayDocsOpenApiInfo);
 
                 if (options.OcelotGatewayItSelfSwaggerGenOptions is not null)
                 {

src/MMLib.SwaggerForOcelot/Repositories/SwaggerEndPointProvider.cs

@@ -49,7 +49,7 @@ private Dictionary<string, SwaggerEndPointOptions> Init()
 
             if (_options.GenerateDocsForGatewayItSelf)
             {
-                AddEndpoint(ret, OcelotSwaggerGenOptions.GatewayKey, "Gateway");
+                AddEndpoint(ret, OcelotSwaggerGenOptions.GatewayKey, _options.GatewayDocsTitle);
             }
 
             return ret;