Merge pull request #1640 from domaindrivendev/config-method-for-addin…

…g-servers

Add config method to simplify adding server(s) information

src/Swashbuckle.AspNetCore.Swagger/SwaggerMiddleware.cs

@@ -33,9 +33,9 @@ public async Task Invoke(HttpContext httpContext, ISwaggerProvider swaggerProvid
                 return;
             }
 
-            var basePath = string.IsNullOrEmpty(httpContext.Request.PathBase)
-                ? null
-                : httpContext.Request.PathBase.ToString();
+            var basePath = !string.IsNullOrEmpty(httpContext.Request.PathBase)
+                ? httpContext.Request.PathBase.ToString()
+                : null;
 
             try
             {

src/Swashbuckle.AspNetCore.SwaggerGen/DependencyInjection/ConfigureSwaggerGeneratorOptions.cs

@@ -62,6 +62,7 @@ public void DeepCopy(SwaggerGeneratorOptions source, SwaggerGeneratorOptions tar
             target.TagsSelector = source.TagsSelector;
             target.SortKeySelector = source.SortKeySelector;
             target.DescribeAllParametersInCamelCase = source.DescribeAllParametersInCamelCase;
+            target.Servers = new List<OpenApiServer>(source.Servers);
             target.SecuritySchemes = new Dictionary<string, OpenApiSecurityScheme>(source.SecuritySchemes);
             target.SecurityRequirements = new List<OpenApiSecurityRequirement>(source.SecurityRequirements);
             target.ParameterFilters = new List<IParameterFilter>(source.ParameterFilters);

src/Swashbuckle.AspNetCore.SwaggerGen/DependencyInjection/SwaggerGenOptionsExtensions.cs

@@ -124,6 +124,17 @@ public static void DescribeAllParametersInCamelCase(this SwaggerGenOptions swagg
             swaggerGenOptions.SwaggerGeneratorOptions.DescribeAllParametersInCamelCase = true;
         }
 
+
+        /// <summary>
+        /// Provide specific server information to include in the generated Swagger document
+        /// </summary>
+        /// <param name="swaggerGenOptions"></param>
+        /// <param name="server">A description of the server</param>
+        public static void AddServer(this SwaggerGenOptions swaggerGenOptions, OpenApiServer server)
+        {
+            swaggerGenOptions.SwaggerGeneratorOptions.Servers.Add(server);
+        }
+
         /// <summary>
         /// Add one or more "securityDefinitions", describing how your API is protected, to the generated Swagger
         /// </summary>

src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs

@@ -64,6 +64,11 @@ public OpenApiDocument GetSwagger(string documentName, string host = null, strin
 
         private IList<OpenApiServer> GenerateServers(string host, string basePath)
         {
+            if (_options.Servers.Any())
+            {
+                return new List<OpenApiServer>(_options.Servers);
+            }
+
             return (host == null && basePath == null)
                 ? new List<OpenApiServer>()
                 : new List<OpenApiServer> { new OpenApiServer { Url = $"{host}{basePath}" } };

src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGeneratorOptions.cs

@@ -15,6 +15,7 @@ public SwaggerGeneratorOptions()
             OperationIdSelector = DefaultOperationIdSelector;
             TagsSelector = DefaultTagsSelector;
             SortKeySelector = DefaultSortKeySelector;
+            Servers = new List<OpenApiServer>();
             SecuritySchemes = new Dictionary<string, OpenApiSecurityScheme>();
             SecurityRequirements = new List<OpenApiSecurityRequirement>();
             ParameterFilters = new List<IParameterFilter>();
@@ -39,6 +40,8 @@ public SwaggerGeneratorOptions()
 
         public bool DescribeAllParametersInCamelCase { get; set; }
 
+        public List<OpenApiServer> Servers { get; set; }
+
         public IDictionary<string, OpenApiSecurityScheme> SecuritySchemes { get; set; }
 
         public IList<OpenApiSecurityRequirement> SecurityRequirements { get; set; }

test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs

@@ -705,6 +705,30 @@ public void GetSwagger_SupportsOption_DescribeAllParametersInCamelCase()
             Assert.Equal("someParam", operation.Parameters.First().Name);
         }
 
+        [Fact]
+        public void GetSwagger_SupportsOption_Servers()
+        {
+            var subject = Subject(
+                apiDescriptions: new ApiDescription[] { },
+                options: new SwaggerGeneratorOptions
+                {
+                    SwaggerDocs = new Dictionary<string, OpenApiInfo>
+                    {
+                        ["v1"] = new OpenApiInfo { Version = "V1", Title = "Test API" }
+                    },
+                    Servers = new List<OpenApiServer>
+                    {
+                        new OpenApiServer { Url = "http://tempuri.org/api" }
+                    }
+                }
+            );
+
+            var document = subject.GetSwagger("v1");
+
+            Assert.Equal(1, document.Servers.Count);
+            Assert.Equal("http://tempuri.org/api", document.Servers.First().Url);
+        }
+
         [Fact]
         public void GetSwagger_SupportsOption_SecuritySchemes()
         {

test/WebSites/NetCore21/Startup.cs

@@ -31,7 +31,8 @@ public void ConfigureServices(IServiceCollection services)
 
             services.AddSwaggerGen(c =>
             {
-                //c.SwaggerDoc("v1", new OpenApiInfo { Title = "Test API", Version = "1" });
+                c.SwaggerDoc("v1", new OpenApiInfo { Title = "Test API", Version = "1" });
+
                 c.UseInlineDefinitionsForEnums();
             });
             services.AddSwaggerGenNewtonsoftSupport();