Add built-in OpenAPI app settings object (Azure#525)

Author: justinyoo

src/Microsoft.Azure.Functions.Worker.Extensions.OpenApi/Configurations/OpenApiAuthLevelSettings.cs

@@ -0,0 +1,18 @@
+namespace Microsoft.Azure.Functions.Worker.Extensions.OpenApi.Configurations
+{
+    /// <summary>
+    /// This represents the environment variable settings entity for OpenAPI document auth level.
+    /// </summary>
+    public class OpenApiAuthLevelSettings
+    {
+        /// <summary>
+        /// Gets or sets the <see cref="AuthorizationLevel"/> value for OpenAPI document rendering endpoints.
+        /// </summary>
+        public virtual AuthorizationLevel? Document { get; set; }
+
+        /// <summary>
+        /// Gets or sets the <see cref="AuthorizationLevel"/> value for Swagger UI page rendering endpoints.
+        /// </summary>
+        public virtual AuthorizationLevel? UI { get; set; }
+    }
+}

src/Microsoft.Azure.Functions.Worker.Extensions.OpenApi/Configurations/OpenApiSettings.cs

@@ -0,0 +1,75 @@
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Enums;
+
+namespace Microsoft.Azure.Functions.Worker.Extensions.OpenApi.Configurations
+{
+    /// <summary>
+    /// This represents the environment variable settings entity for OpenAPI document.
+    /// </summary>
+    public class OpenApiSettings
+    {
+        /// <summary>
+        /// Gets the name of the collection of the environment variables for OpenAPI.
+        /// </summary>
+        public const string Name = "OpenApi";
+
+        /// <summary>
+        /// Gets or sets the OpenAPI spec version.
+        /// </summary>
+        public virtual OpenApiVersionType Version { get; set; }
+
+        /// <summary>
+        /// Gets or sets the OpenAPI document version.
+        /// </summary>
+        public virtual string DocVersion { get; set; }
+
+        /// <summary>
+        /// Gets or sets the OpenAPI document title.
+        /// </summary>
+        public virtual string DocTitle { get; set; }
+
+        /// <summary>
+        /// Gets or sets the OpenAPI document description.
+        /// </summary>
+        public virtual string DocDescription { get; set; }
+
+        /// <summary>
+        /// Gets or sets the comma delimited host names.
+        /// </summary>
+        public virtual string HostNames { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value indicating whether to force the HTTPS connection or not.
+        /// </summary>
+        public virtual bool ForceHttps { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value indicating whether to force the HTTP connection or not.
+        /// </summary>
+        public virtual bool ForceHttp { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value indicating whether to hide the Swagger UI page or not.
+        /// </summary>
+        public virtual bool HideSwaggerUI { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value indicating whether to hide the OpenAPI document pages or not.
+        /// </summary>
+        public virtual bool HideDocument { get; set; }
+
+        /// <summary>
+        /// Gets or sets the API key to access to OpenAPI document.
+        /// </summary>
+        public virtual string ApiKey { get; set; }
+
+        /// <summary>
+        /// Gets or sets the <see cref="OpenApiAuthLevelSettings"/> object.
+        /// </summary>
+        public virtual OpenApiAuthLevelSettings AuthLevel { get; set; } = new OpenApiAuthLevelSettings();
+
+        /// <summary>
+        /// Gets or sets the backend URL for Azure Functions Proxy.
+        /// </summary>
+        public virtual string BackendProxyUrl { get; set; }
+    }
+}

src/Microsoft.Azure.Functions.Worker.Extensions.OpenApi/HttpRequestObject.cs

@@ -1,5 +1,7 @@
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Security.Claims;
 
 using Microsoft.AspNetCore.Http;
 using Microsoft.Azure.Functions.Worker.Extensions.OpenApi.Extensions;
@@ -29,6 +31,7 @@ public HttpRequestObject(HttpRequestData req)
 
             this.Headers = req.Headers();
             this.Query = req.Queries();
+            this.Identities = req.Identities;
             this.Body = req.Body;
         }
 
@@ -42,9 +45,13 @@ public HttpRequestObject(HttpRequestData req)
         public virtual IHeaderDictionary Headers { get; }
 
         /// <inheritdoc/>
-        public virtual IQueryCollection Query { get;}
+        public virtual IQueryCollection Query { get; }
 
         /// <inheritdoc/>
-        public virtual Stream Body { get;}
+        /// <remarks>This property has implementation but will appear on the interface from v2.0.0.</remarks>
+        public virtual IEnumerable<ClaimsIdentity> Identities { get; }
+
+        /// <inheritdoc/>
+        public virtual Stream Body { get; }
     }
 }

src/Microsoft.Azure.Functions.Worker.Extensions.OpenApi/OpenApiWorkerStartup.cs

@@ -1,6 +1,9 @@
 using Microsoft.Azure.Functions.Worker.Core;
 using Microsoft.Azure.Functions.Worker.Extensions.OpenApi;
+using Microsoft.Azure.Functions.Worker.Extensions.OpenApi.Configurations;
 using Microsoft.Azure.Functions.Worker.Extensions.OpenApi.Functions;
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Configurations.AppSettings.Extensions;
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Configurations.AppSettings.Resolvers;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -16,6 +19,10 @@ public class OpenApiWorkerStartup : WorkerExtensionStartup
         /// <inheritdoc />
         public override void Configure(IFunctionsWorkerApplicationBuilder applicationBuilder)
         {
+            var config = ConfigurationResolver.Resolve();
+            var settings = config.Get<OpenApiSettings>(OpenApiSettings.Name);
+
+            applicationBuilder.Services.AddSingleton(settings);
             applicationBuilder.Services.AddSingleton<IOpenApiHttpTriggerContext, OpenApiHttpTriggerContext>();
             applicationBuilder.Services.AddSingleton<IOpenApiTriggerFunction, OpenApiTriggerFunction>();
             //applicationBuilder.Services.AddSingleton<DefaultOpenApiHttpTrigger, DefaultOpenApiHttpTrigger>();

src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Abstractions/IHttpRequestDataObject.cs

@@ -1,4 +1,6 @@
+using System.Collections.Generic;
 using System.IO;
+using System.Security.Claims;
 
 using Microsoft.AspNetCore.Http;
 
@@ -29,9 +31,15 @@ public interface IHttpRequestDataObject
         /// </summary>
         IQueryCollection Query { get; }
 
+        /// <summary>
+        /// Gets the list of <see cref="ClaimsIdentity"/>
+        /// </summary>
+        /// <remarks>This will be added to v2.0.0</remarks>
+        //IEnumerable<ClaimsIdentity> Identities { get; }
+
         /// <summary>
         /// Gets the request payload stream.
         /// </summary>
-        Stream Body { get;}
+        Stream Body { get; }
     }
 }

src/Microsoft.Azure.WebJobs.Extensions.OpenApi/Configurations/OpenApiSettings.cs

@@ -7,6 +7,11 @@ namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Configurations
     /// </summary>
     public class OpenApiSettings
     {
+        /// <summary>
+        /// Gets the name of the collection of the environment variables for OpenAPI.
+        /// </summary>
+        public const string Name = "OpenApi";
+
         /// <summary>
         /// Gets or sets the OpenAPI spec version.
         /// </summary>

src/Microsoft.Azure.WebJobs.Extensions.OpenApi/HttpRequestObject.cs

@@ -1,4 +1,6 @@
+using System.Collections.Generic;
 using System.IO;
+using System.Security.Claims;
 
 using Microsoft.AspNetCore.Http;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions;
@@ -23,6 +25,7 @@ public HttpRequestObject(HttpRequest req)
             this.Host = req.Host;
             this.Headers = req.Headers;
             this.Query = req.Query;
+            this.Identities = req.HttpContext.User.Identities;
             this.Body = req.Body;
         }
 
@@ -36,9 +39,13 @@ public HttpRequestObject(HttpRequest req)
         public virtual IHeaderDictionary Headers { get; }
 
         /// <inheritdoc/>
-        public virtual IQueryCollection Query { get;}
+        public virtual IQueryCollection Query { get; }
 
         /// <inheritdoc/>
-        public virtual Stream Body { get;}
+        /// <remarks>This property has implementation but will appear on the interface from v2.0.0.</remarks>
+        public virtual IEnumerable<ClaimsIdentity> Identities { get; }
+
+        /// <inheritdoc/>
+        public virtual Stream Body { get; }
     }
 }

src/Microsoft.Azure.WebJobs.Extensions.OpenApi/OpenApiWebJobsStartup.cs

@@ -17,13 +17,11 @@ namespace Microsoft.Azure.WebJobs.Extensions.OpenApi
     /// </summary>
     public class OpenApiWebJobsStartup : IWebJobsStartup
     {
-        private const string OpenApiSettingsKey = "OpenApi";
-
         /// <inheritdoc />
         public void Configure(IWebJobsBuilder builder)
         {
             var config = ConfigurationResolver.Resolve();
-            var settings = config.Get<OpenApiSettings>(OpenApiSettingsKey);
+            var settings = config.Get<OpenApiSettings>(OpenApiSettings.Name);
 
             builder.Services.AddSingleton(settings);
             builder.Services.AddSingleton<IFunctionProvider, OpenApiTriggerFunctionProvider>();