Azure · justinyoo · Feb 9, 2021 · Feb 9, 2021
diff --git a/...Jobs.Extensions.OpenApi.FunctionApp.V1Proxy/Configurations/OpenApiConfigurationOptions.cs b/...Jobs.Extensions.OpenApi.FunctionApp.V1Proxy/Configurations/OpenApiConfigurationOptions.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.OpenApi.Models;
@@ -25,5 +26,7 @@ public class OpenApiConfigurationOptions : IOpenApiConfigurationOptions
                 Url = new Uri("http://opensource.org/licenses/MIT"),
             }
         };
+
+        public List<OpenApiServer> Servers { get; set; } = new List<OpenApiServer>();
     }
 }
diff --git a/...ebJobs.Extensions.OpenApi.FunctionApp.V2IoC/Configurations/OpenApiConfigurationOptions.cs b/...ebJobs.Extensions.OpenApi.FunctionApp.V2IoC/Configurations/OpenApiConfigurationOptions.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.OpenApi.Models;
@@ -25,5 +26,7 @@ public class OpenApiConfigurationOptions : IOpenApiConfigurationOptions
                 Url = new Uri("http://opensource.org/licenses/MIT"),
             }
         };
+
+        public List<OpenApiServer> Servers { get; set; } = new List<OpenApiServer>();
     }
 }
diff --git a/...obs.Extensions.OpenApi.FunctionApp.V2Static/Configurations/OpenApiConfigurationOptions.cs b/...obs.Extensions.OpenApi.FunctionApp.V2Static/Configurations/OpenApiConfigurationOptions.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.OpenApi.Models;
@@ -25,5 +26,7 @@ public class OpenApiConfigurationOptions : IOpenApiConfigurationOptions
                 Url = new Uri("http://opensource.org/licenses/MIT"),
             }
         };
+
+        public List<OpenApiServer> Servers { get; set; } = new List<OpenApiServer>();
     }
 }
diff --git a/...ebJobs.Extensions.OpenApi.FunctionApp.V3IoC/Configurations/OpenApiConfigurationOptions.cs b/...ebJobs.Extensions.OpenApi.FunctionApp.V3IoC/Configurations/OpenApiConfigurationOptions.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.OpenApi.Models;
@@ -25,5 +26,7 @@ public class OpenApiConfigurationOptions : IOpenApiConfigurationOptions
                 Url = new Uri("http://opensource.org/licenses/MIT"),
             }
         };
+
+        public List<OpenApiServer> Servers { get; set; } = new List<OpenApiServer>();
     }
 }
diff --git a/...obs.Extensions.OpenApi.FunctionApp.V3Static/Configurations/OpenApiConfigurationOptions.cs b/...obs.Extensions.OpenApi.FunctionApp.V3Static/Configurations/OpenApiConfigurationOptions.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.OpenApi.Models;
@@ -25,5 +26,11 @@ public class OpenApiConfigurationOptions : IOpenApiConfigurationOptions
                 Url = new Uri("http://opensource.org/licenses/MIT"),
             }
         };
+
+        public List<OpenApiServer> Servers { get; set; } = new List<OpenApiServer>()
+        {
+            new OpenApiServer() { Url = "https://contoso.com/api/" },
+            new OpenApiServer() { Url = "https://fabrikam.com/api/" },
+        };
     }
 }
diff --git a/...soft.Azure.WebJobs.Extensions.OpenApi.Core/Configurations/IOpenApiConfigurationOptions.cs b/...soft.Azure.WebJobs.Extensions.OpenApi.Core/Configurations/IOpenApiConfigurationOptions.cs
@@ -1,3 +1,5 @@
+using System.Collections.Generic;
+
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations
@@ -11,5 +13,10 @@ public interface IOpenApiConfigurationOptions
         /// Gets or sets the <see cref="OpenApiInfo"/> instance.
         /// </summary>
         OpenApiInfo Info { get; set; }
+
+        /// <summary>
+        /// Gets or sets the list of <see cref="OpenApiServer"/> instances.
+        /// </summary>
+        List<OpenApiServer> Servers { get; set; }
     }
 }
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Configurations/OpenApiAppSettingsBase.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Configurations/OpenApiAppSettingsBase.cs
@@ -20,8 +20,9 @@ protected OpenApiAppSettingsBase()
         {
             var basePath = this.GetBasePath();
             var host = HostJsonResolver.Resolve(this.Config, basePath);
+            var options = OpenApiConfigurationResolver.Resolve(Assembly.GetExecutingAssembly());
 
-            this.OpenApiInfo = OpenApiInfoResolver.Resolve(Assembly.GetExecutingAssembly());
+            this.OpenApiInfo = options.Info;
             this.SwaggerAuthKey = this.Config.GetValue<string>("OpenApi:ApiKey");
 
             this.HttpSettings = host.GetHttpSettings();

diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Configurations/OpenApiSettings.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Configurations/OpenApiSettings.cs
@@ -1,3 +1,5 @@
+using System.Collections.Generic;
+
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations
@@ -13,5 +15,8 @@ public sealed class OpenApiSettings : IOpenApiConfigurationOptions
             Version = "1.0.0",
             Title = "Azure Functions Open API Extension",
         };
+
+        /// <inheritdoc />
+        public List<OpenApiServer> Servers { get; set; } = new List<OpenApiServer>();
     }
 }
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Document.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Document.cs
@@ -1,11 +1,12 @@
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Reflection;
 using System.Threading.Tasks;
 
 using Microsoft.AspNetCore.Http;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions;
-using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Comparers;
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Extensions;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Visitors;
 using Microsoft.OpenApi;
@@ -33,6 +34,13 @@ public Document(IDocumentHelper helper)
             this._helper = helper.ThrowIfNullOrDefault();
         }
 
+        /// <inheritdoc />
+        public Document(OpenApiDocument openApiDocument)
+        {
+            this.OpenApiDocument = openApiDocument;
+
+        }
+
         /// <inheritdoc />
         public OpenApiDocument OpenApiDocument { get; private set; }
 
@@ -56,12 +64,27 @@ public IDocument AddMetadata(OpenApiInfo info)
         }
 
         /// <inheritdoc />
-        public IDocument AddServer(HttpRequest req, string routePrefix)
+        public IDocument AddServer(HttpRequest req, string routePrefix, IOpenApiConfigurationOptions options = null)
         {
             var prefix = string.IsNullOrWhiteSpace(routePrefix) ? string.Empty : $"/{routePrefix}";
             var baseUrl = $"{req.Scheme}://{req.Host}{prefix}";
 
-            this.OpenApiDocument.Servers.Add(new OpenApiServer { Url = baseUrl });
+            var server = new OpenApiServer { Url = baseUrl };
+
+            if (options.IsNullOrDefault())
+            {
+                this.OpenApiDocument.Servers = new List<OpenApiServer>() { server };
+
+                return this;
+            }
+
+            // Filters out the existing base URLs that are the same as the current host URL.
+            var servers = options.Servers
+                                 .Where(p => p.Url.TrimEnd('/') != baseUrl.TrimEnd('/'))
+                                 .ToList();
+            servers.Insert(0, server);
+
+            this.OpenApiDocument.Servers = servers;
 
             return this;
         }

diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/IDocument.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/IDocument.cs
@@ -2,6 +2,7 @@
 using System.Threading.Tasks;
 
 using Microsoft.AspNetCore.Http;
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Visitors;
 using Microsoft.OpenApi;
 using Microsoft.OpenApi.Models;
@@ -38,8 +39,9 @@ public interface IDocument
         /// </summary>
         /// <param name="req"><see cref="HttpRequest"/> instance.</param>
         /// <param name="routePrefix">Route prefix value.</param>
+        /// <param name="options"><see cref="IOpenApiConfigurationOptions"/> instance.</param>
         /// <returns><see cref="IDocument"/> instance.</returns>
-        IDocument AddServer(HttpRequest req, string routePrefix);
+        IDocument AddServer(HttpRequest req, string routePrefix, IOpenApiConfigurationOptions options = null);
 
         /// <summary>
         /// Adds the naming strategy.

diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/ISwaggerUI.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/ISwaggerUI.cs
@@ -1,6 +1,7 @@
 using System.Threading.Tasks;
 
 using Microsoft.AspNetCore.Http;
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions
@@ -22,8 +23,9 @@ public interface ISwaggerUI
         /// </summary>
         /// <param name="req"><see cref="HttpRequest"/> instance.</param>
         /// <param name="routePrefix">Route prefix value.</param>
+        /// <param name="options"><see cref="IOpenApiConfigurationOptions"/> instance.</param>
         /// <returns><see cref="IDocument"/> instance.</returns>
-        ISwaggerUI AddServer(HttpRequest req, string routePrefix);
+        ISwaggerUI AddServer(HttpRequest req, string routePrefix, IOpenApiConfigurationOptions options = null);
 
         /// <summary>
         /// Builds Open API document.

diff --git a/...Api.Core/Resolvers/OpenApiInfoResolver.cs → ...Resolvers/OpenApiConfigurationResolver.cs b/...Api.Core/Resolvers/OpenApiInfoResolver.cs → ...Resolvers/OpenApiConfigurationResolver.cs
@@ -9,29 +9,29 @@
 namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Resolvers
 {
     /// <summary>
-    /// This represents the resolver entity for <see cref="OpenApiInfo"/> from one of host.json, openapisettings.json and environment variables.
+    /// This represents the resolver entity for <see cref="OpenApiServer"/>.
     /// </summary>
-    public static class OpenApiInfoResolver
+    public static class OpenApiConfigurationResolver
     {
         /// <summary>
-        /// Gets the <see cref="OpenApiInfo"/> instance from one of host.json, openapisettings.json and environment variables.
+        /// Gets the <see cref="IOpenApiConfigurationOptions"/> instance from the given assembly.
         /// </summary>
         /// <param name="assembly">The executing assembly instance.</param>
-        /// <returns>Returns <see cref="OpenApiInfo"/> instance resolved.</returns>
-        public static OpenApiInfo Resolve(Assembly assembly)
+        /// <returns>Returns the <see cref="IOpenApiConfigurationOptions"/> instance resolved.</returns>
+        public static IOpenApiConfigurationOptions Resolve(Assembly assembly)
         {
             var type = assembly.GetTypes()
                                .SingleOrDefault(p => p.GetInterface("IOpenApiConfigurationOptions", ignoreCase: true).IsNullOrDefault() == false);
             if (type.IsNullOrDefault())
             {
                 var settings = new OpenApiSettings();
 
-                return settings.Info;
+                return settings;
             }
 
             var options = Activator.CreateInstance(type);
 
-            return (options as IOpenApiConfigurationOptions).Info;
+            return options as IOpenApiConfigurationOptions;
         }
     }
 }
diff --git a/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/SwaggerUI.cs b/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/SwaggerUI.cs
@@ -1,9 +1,11 @@
 using System.IO;
+using System.Linq;
 using System.Reflection;
 using System.Threading.Tasks;
 
 using Microsoft.AspNetCore.Http;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions;
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Extensions;
 using Microsoft.OpenApi.Models;
 
@@ -41,11 +43,26 @@ public ISwaggerUI AddMetadata(OpenApiInfo info)
         }
 
         /// <inheritdoc />
-        public ISwaggerUI AddServer(HttpRequest req, string routePrefix)
+        public ISwaggerUI AddServer(HttpRequest req, string routePrefix, IOpenApiConfigurationOptions options = null)
         {
             var prefix = string.IsNullOrWhiteSpace(routePrefix) ? string.Empty : $"/{routePrefix}";
             var baseUrl = $"{req.Scheme}://{req.Host}{prefix}";
-            this._baseUrl = baseUrl;
+
+            if (options.IsNullOrDefault())
+            {
+                this._baseUrl = baseUrl;
+
+                return this;
+            }
+
+            var server = new OpenApiServer { Url = baseUrl };
+            // Filters out the existing base URLs that are the same as the current host URL.
+            var servers = options.Servers
+                                 .Where(p => p.Url.TrimEnd('/') != baseUrl.TrimEnd('/'))
+                                 .ToList();
+            servers.Insert(0, server);
+
+            this._baseUrl = servers.First().Url;
 
             return this;
         }
@@ -97,7 +114,7 @@ public async Task<string> RenderAsync(string endpoint, string authKey = null)
         private string Render(string endpoint, string authKey = null)
         {
             var swaggerUiTitle = $"{this._info.Title} - Swagger UI";
-            var swaggerUrl = $"{this._baseUrl}/{endpoint}";
+            var swaggerUrl = $"{this._baseUrl.TrimEnd('/')}/{endpoint}";
             if (!string.IsNullOrWhiteSpace(authKey))
             {
                 swaggerUrl += $"?code={authKey}";

diff --git a/templates/OpenApiEndpoints/IOpenApiHttpTriggerContext.cs b/templates/OpenApiEndpoints/IOpenApiHttpTriggerContext.cs
@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using System.Reflection;
 
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions;
@@ -18,9 +19,9 @@ namespace Microsoft.Azure.WebJobs.Extensions.OpenApi
     public interface IOpenApiHttpTriggerContext
     {
         /// <summary>
-        /// Gets the <see cref="OpenApiInfo"/> instance.
+        /// Gets the <see cref="IOpenApiConfigurationOptions"/> instance.
         /// </summary>
-        OpenApiInfo OpenApiInfo { get; }
+        IOpenApiConfigurationOptions OpenApiConfiguration { get; }
 
         /// <summary>
         /// Gets the <see cref="HttpSettings"/> instance.

diff --git a/templates/OpenApiEndpoints/OpenApiHttpTrigger.cs b/templates/OpenApiEndpoints/OpenApiHttpTrigger.cs
@@ -48,8 +48,8 @@ public static async Task<IActionResult> RenderSwaggerDocument(
 
             var result = await context.Document
                                       .InitialiseDocument()
-                                      .AddMetadata(context.OpenApiInfo)
-                                      .AddServer(req, context.HttpSettings.RoutePrefix)
+                                      .AddMetadata(context.OpenApiConfiguration.Info)
+                                      .AddServer(req, context.HttpSettings.RoutePrefix, context.OpenApiConfiguration)
                                       .AddNamingStrategy(context.NamingStrategy)
                                       .AddVisitors(context.GetVisitorCollection())
                                       .Build(context.GetExecutingAssembly())
@@ -86,8 +86,8 @@ public static async Task<IActionResult> RenderOpenApiDocument(
 
             var result = await context.Document
                                       .InitialiseDocument()
-                                      .AddMetadata(context.OpenApiInfo)
-                                      .AddServer(req, context.HttpSettings.RoutePrefix)
+                                      .AddMetadata(context.OpenApiConfiguration.Info)
+                                      .AddServer(req, context.HttpSettings.RoutePrefix, context.OpenApiConfiguration)
                                       .AddNamingStrategy(context.NamingStrategy)
                                       .AddVisitors(context.GetVisitorCollection())
                                       .Build(context.GetExecutingAssembly())
@@ -119,8 +119,8 @@ public static async Task<IActionResult> RenderSwaggerUI(
             log.LogInformation($"SwaggerUI page was requested.");
 
             var result = await context.SwaggerUI
-                                      .AddMetadata(context.OpenApiInfo)
-                                      .AddServer(req, context.HttpSettings.RoutePrefix)
+                                      .AddMetadata(context.OpenApiConfiguration.Info)
+                                      .AddServer(req, context.HttpSettings.RoutePrefix, context.OpenApiConfiguration)
                                       .BuildAsync()
                                       .RenderAsync("swagger.json", context.GetSwaggerAuthKey())
                                       .ConfigureAwait(false);

diff --git a/templates/OpenApiEndpoints/OpenApiHttpTriggerContext.cs b/templates/OpenApiEndpoints/OpenApiHttpTriggerContext.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
 
@@ -35,7 +36,7 @@ public OpenApiHttpTriggerContext()
         {
             var host = HostJsonResolver.Resolve();
 
-            this.OpenApiInfo = OpenApiInfoResolver.Resolve(this.GetExecutingAssembly());
+            this.OpenApiConfiguration = OpenApiConfigurationResolver.Resolve(this.GetExecutingAssembly());
             this.HttpSettings = host.GetHttpSettings();
 
             var filter = new RouteConstraintFilter();
@@ -47,7 +48,7 @@ public OpenApiHttpTriggerContext()
         }
 
         /// <inheritdoc />
-        public virtual OpenApiInfo OpenApiInfo { get; }
+        public virtual IOpenApiConfigurationOptions OpenApiConfiguration { get; }
 
         /// <inheritdoc />
         public virtual HttpSettings HttpSettings { get; }