Skip to content

Support dynamic OpenApiConfigurationOptions #432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Aug 8, 2022
Merged

Support dynamic OpenApiConfigurationOptions #432

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b035471
First pass at support dynamic OpenApiConfigurationOptions.
jackbatzner May 6, 2022
4ba1e5a
Put that back
jackbatzner May 6, 2022
3070225
Update readme to include info on how to dynamically configure OpenApi…
jackbatzner May 6, 2022
dd24b58
Update tests
jackbatzner May 6, 2022
e1d0247
Allow proper dependency injection for IOpenApiConfigurationOptions
jackbatzner Aug 2, 2022
9532164
Cleanup
jackbatzner Aug 2, 2022
d1181e2
Merge branch 'main' into dynamic-openapiconfig
jackbatzner Aug 2, 2022
774370a
Update openapi-core.md
jackbatzner Aug 2, 2022
0f3e3b6
Update comment
jackbatzner Aug 2, 2022
b096f0e
Merge branch 'dynamic-openapiconfig' of github.com:jackbatzner/azure-…
jackbatzner Aug 2, 2022
b22d8d7
Fix tests
jackbatzner Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion samples/Microsoft.Azure.Functions.Worker.Extensions.OpenApi.FunctionApp.OutOfProc/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
using AutoFixture;

using Microsoft.Azure.Functions.Worker.Extensions.OpenApi.Extensions;
using Microsoft.Azure.Functions.Worker.Extensions.OpenApi.FunctionApp.OutOfProc.Configurations;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

Expand All @@ -13,7 +15,23 @@ public static void Main()
var host = new HostBuilder()
.ConfigureFunctionsWorkerDefaults(worker => worker.UseNewtonsoftJson())
.ConfigureOpenApi()
.ConfigureServices(services => services.AddSingleton<Fixture>())
.ConfigureServices(services => {
services.AddSingleton<Fixture>();

// Example: If you want to change the configuration during startup of your function you can use the following code:

//services.AddSingleton<IOpenApiConfigurationOptions>(x =>
//{
// return new OpenApiConfigurationOptions()
// {
// Info = new Microsoft.OpenApi.Models.OpenApiInfo
// {
// Title = "A dynamic title generated at runtime",
// Description = "Dynamic Open API information at runtime"
// }
// };
//});
})
.Build();

host.Run();
Expand Down
19 changes: 18 additions & 1 deletion samples/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.InProc/Startup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
using AutoFixture;

using Microsoft.Azure.Functions.Extensions.DependencyInjection;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Extensions;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Resolvers;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.InProc.Configurations;
using Microsoft.Extensions.DependencyInjection;

[assembly: FunctionsStartup(typeof(Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.InProc.Startup))]
Expand All @@ -12,7 +16,20 @@ public class Startup : FunctionsStartup
public override void Configure(IFunctionsHostBuilder builder)
{
var fixture = new Fixture();
builder.Services.AddSingleton(fixture);
builder.Services.AddSingleton(fixture);

// Example: If you want to change the configuration during startup of your function you can use the following code:

//var test = new OpenApiConfigurationOptions()
//{
// Info = new Microsoft.OpenApi.Models.OpenApiInfo
// {
// Title = "A dynamic title generated at runtime",
// Description = "Dynamic Open API information at runtime"
// }
//};

//OpenApiConfigurationResolver.ConfigurationOptions = test;
}
}
}
4 changes: 3 additions & 1 deletion ...soft.Azure.Functions.Worker.Extensions.OpenApi/Extensions/OpenApiHostBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using Microsoft.Azure.Functions.Worker.Extensions.OpenApi.Functions;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

Expand All @@ -20,7 +21,8 @@ public static IHostBuilder ConfigureOpenApi(this IHostBuilder hostBuilder)
hostBuilder.ConfigureServices(services =>
{
services.AddSingleton<IOpenApiHttpTriggerContext, OpenApiHttpTriggerContext>();
services.AddSingleton<IOpenApiTriggerFunction, OpenApiTriggerFunction>();
services.AddSingleton<IOpenApiTriggerFunction, OpenApiTriggerFunction>();
services.AddSingleton<IOpenApiConfigurationOptions, DefaultOpenApiConfigurationOptions>();
// services.AddSingleton<DefaultOpenApiHttpTrigger, DefaultOpenApiHttpTrigger>();
});

Expand Down
3 changes: 2 additions & 1 deletion src/Microsoft.Azure.Functions.Worker.Extensions.OpenApi/OpenApiHttpTriggerContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ public class OpenApiHttpTriggerContext : IOpenApiHttpTriggerContext
/// <summary>
/// Initializes a new instance of the <see cref="OpenApiHttpTriggerContext"/> class.
/// </summary>
public OpenApiHttpTriggerContext()
public OpenApiHttpTriggerContext(IOpenApiConfigurationOptions configOptions)
{
this._configOptions = configOptions;
this.PackageAssembly = this.GetAssembly<ISwaggerUI>();

var host = HostJsonResolver.Resolve();
Expand Down
26 changes: 18 additions & 8 deletions ...Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Resolvers/OpenApiConfigurationResolver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,46 @@
using System;
using System.Linq;
using System.Reflection;

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;
using System;
using System.Linq;
using System.Reflection;

namespace Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Resolvers
{
/// <summary>
/// This represents the resolver entity for <see cref="OpenApiServer"/>.
/// </summary>
public static class OpenApiConfigurationResolver
{
{
/// <summary>
/// Property used to allow for dynamic generation of OpenApiConfigurationOptions
/// </summary>
public static IOpenApiConfigurationOptions ConfigurationOptions { get; set; }

/// <summary>
/// Gets the <see cref="IOpenApiConfigurationOptions"/> instance from the given assembly.
/// </summary>
/// <param name="assembly">The executing assembly instance.</param>
/// <returns>Returns the <see cref="IOpenApiConfigurationOptions"/> instance resolved.</returns>
public static IOpenApiConfigurationOptions Resolve(Assembly assembly)
{
{
// If we have already dynamically configured the <see cref="IOpenApiConfigurationOptions"/>, then return it
if (ConfigurationOptions != null)
{
return ConfigurationOptions;
}

var type = assembly.GetLoadableTypes()
.SingleOrDefault(p => p.GetInterface("IOpenApiConfigurationOptions", ignoreCase: true).IsNullOrDefault() == false
&& p.IsAbstract == false
&& p.GetCustomAttribute<ObsoleteAttribute>(inherit: false).IsNullOrDefault() == true);
if (type.IsNullOrDefault())
if (type.IsNullOrDefault())
{
var settings = new DefaultOpenApiConfigurationOptions();

return settings;
}
}

var options = Activator.CreateInstance(type);

Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Azure.WebJobs.Extensions.OpenApi/OpenApiHttpTriggerContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public class OpenApiHttpTriggerContext : IOpenApiHttpTriggerContext
private IOpenApiCustomUIOptions _uiOptions;

/// <summary>
/// Initializes a new instance of the <see cref="OpenApiTriggerFunctionProvider"/> class.
/// Initializes a new instance of the <see cref="OpenApiHttpTriggerContext"/> class.
/// </summary>
public OpenApiHttpTriggerContext()
{
Expand Down
20 changes: 10 additions & 10 deletions ...crosoft.Azure.Functions.Worker.Extensions.OpenApi.Tests/OpenApiHttpTriggerContextTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public class OpenApiHttpTriggerContextTests
public async Task Given_Type_When_Initiated_Then_It_Should_Return_ApplicationAssemblyWithGivenType(Type type)
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var assembly = (await context.SetApplicationAssemblyAsync(location, false))
.ApplicationAssembly;
Expand All @@ -39,7 +39,7 @@ public async Task Given_Type_When_Initiated_Then_It_Should_Return_ApplicationAss
public async Task Given_Type_With_Referenced_Project_When_Initiated_Then_It_Should_Return_ApplicationAssemblyOfRootAssembly()
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var assembly = (await context.SetApplicationAssemblyAsync(location, false))
.ApplicationAssembly;
Expand All @@ -55,7 +55,7 @@ public async Task Given_Type_With_Referenced_Project_When_Initiated_Then_It_Shou
public async Task Given_Type_When_Initiated_Then_It_Should_NotReturn_ApplicationAssemblyWithGivenType(Type type)
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var assembly = (await context.SetApplicationAssemblyAsync(location, false))
.ApplicationAssembly;
Expand All @@ -69,7 +69,7 @@ public async Task Given_Type_When_Initiated_Then_It_Should_NotReturn_Application
public async Task Given_Type_When_Initiated_Then_It_Should_Return_PackageAssembly()
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var assembly = (await context.SetApplicationAssemblyAsync(location, false))
.PackageAssembly;
Expand All @@ -81,7 +81,7 @@ public async Task Given_Type_When_Initiated_Then_It_Should_Return_PackageAssembl
public async Task Given_Type_When_Initiated_Then_It_Should_Return_OpenApiConfigurationOptions()
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var options = (await context.SetApplicationAssemblyAsync(location, false))
.OpenApiConfigurationOptions;
Expand All @@ -94,7 +94,7 @@ public async Task Given_Type_When_Initiated_Then_It_Should_Return_OpenApiConfigu
public async Task Given_Type_When_Initiated_Then_It_Should_Return_OpenApiCustomUIOptions()
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var options = (await context.SetApplicationAssemblyAsync(location, false))
.OpenApiCustomUIOptions;
Expand All @@ -107,7 +107,7 @@ public async Task Given_Type_When_Initiated_Then_It_Should_Return_OpenApiCustomU
public async Task Given_Type_When_Initiated_Then_It_Should_Return_HttpSettings()
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var settings = (await context.SetApplicationAssemblyAsync(location, false))
.HttpSettings;
Expand All @@ -121,7 +121,7 @@ public async Task Given_Authorization_When_AuthorizeAsync_Invoked_Then_It_Should
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var req = new Mock<IHttpRequestDataObject>();
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var result = await context.SetApplicationAssemblyAsync(location, false)
.AuthorizeAsync(req.Object);
Expand All @@ -137,7 +137,7 @@ public async Task Given_Authorization_When_AuthorizeAsync_Invoked_Then_It_Should
public async Task Given_Type_When_GetOpenApiSpecVersion_Invoked_Then_It_Should_Return_Result(string version, OpenApiSpecVersion expected)
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var result = (await context.SetApplicationAssemblyAsync(location, false))
.GetOpenApiSpecVersion(version);
Expand All @@ -151,7 +151,7 @@ public async Task Given_Type_When_GetOpenApiSpecVersion_Invoked_Then_It_Should_R
public async Task Given_Type_When_GetOpenApiSpecVersion_Invoked_Then_It_Should_Return_Result(string format, OpenApiFormat expected)
{
var location = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.FullName;
var context = new OpenApiHttpTriggerContext();
var context = new OpenApiHttpTriggerContext(null);

var result = (await context.SetApplicationAssemblyAsync(location, false))
.GetOpenApiFormat(format);
Expand Down