Skip to content

Class OpenApiExtensions

Namespace: Momentum.ServiceDefaults.Api.OpenApi.Extensions
Assembly: Momentum.ServiceDefaults.Api.dll

Provides extension methods for configuring OpenAPI using the native .NET 10 source generator.

csharp
public static class OpenApiExtensions

Inheritance

objectOpenApiExtensions

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Methods

ConfigureOpenApiDefaults(OpenApiOptions, IConfiguration?)

Configures OpenAPI options with Momentum's default settings.

csharp
public static OpenApiOptions ConfigureOpenApiDefaults(this OpenApiOptions options, IConfiguration? configuration = null)

Parameters

options OpenApiOptions

The OpenAPI options to configure.

configuration IConfiguration?

Optional application configuration. When provided, security schemes are bound from OpenApi:SecuritySchemes. Each key becomes a scheme name with properties Type, Scheme, BearerFormat, and Description. When null or when the section is absent, no security schemes are added.

Returns

OpenApiOptions

Remarks

This method applies Momentum's standard OpenAPI configuration:

  • Server URL normalization (removes trailing slashes)
  • Config-driven security schemes via OpenApi:SecuritySchemes
  • Schema fixes: removes nullable properties from required arrays, sets decimal format

Call this from your project's AddOpenApi() configuration to apply defaults:

builder.Services.AddOpenApi(options =>
{
    options.ConfigureOpenApiDefaults(builder.Configuration);
    // Add your custom configuration here
});