OpenApiServiceCollectionExtensions.AddOpenApi Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| AddOpenApi(IServiceCollection) |
Adds OpenAPI services related to the default document to the specified IServiceCollection. |
| AddOpenApi(IServiceCollection, Action<OpenApiOptions>) |
Adds OpenAPI services related to the default document to the specified IServiceCollection with the specified options. |
| AddOpenApi(IServiceCollection, String) |
Adds OpenAPI services related to the given document name to the specified IServiceCollection. |
| AddOpenApi(IServiceCollection, String, Action<OpenApiOptions>) |
Adds OpenAPI services related to the given document name to the specified IServiceCollection with the specified options. |
AddOpenApi(IServiceCollection)
Adds OpenAPI services related to the default document to the specified IServiceCollection.
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddOpenApi (this Microsoft.Extensions.DependencyInjection.IServiceCollection services);static member AddOpenApi : Microsoft.Extensions.DependencyInjection.IServiceCollection -> Microsoft.Extensions.DependencyInjection.IServiceCollection<Extension()>
Public Function AddOpenApi (services As IServiceCollection) As IServiceCollectionParameters
- services
- IServiceCollection
The IServiceCollection to register services onto.
Returns
Applies to
AddOpenApi(IServiceCollection, Action<OpenApiOptions>)
Adds OpenAPI services related to the default document to the specified IServiceCollection with the specified options.
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddOpenApi (this Microsoft.Extensions.DependencyInjection.IServiceCollection services, Action<Microsoft.AspNetCore.OpenApi.OpenApiOptions> configureOptions);static member AddOpenApi : Microsoft.Extensions.DependencyInjection.IServiceCollection * Action<Microsoft.AspNetCore.OpenApi.OpenApiOptions> -> Microsoft.Extensions.DependencyInjection.IServiceCollection<Extension()>
Public Function AddOpenApi (services As IServiceCollection, configureOptions As Action(Of OpenApiOptions)) As IServiceCollectionParameters
- services
- IServiceCollection
The IServiceCollection to register services onto.
- configureOptions
- Action<OpenApiOptions>
A delegate used to configure the target OpenApiOptions.
Returns
Applies to
AddOpenApi(IServiceCollection, String)
Adds OpenAPI services related to the given document name to the specified IServiceCollection.
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddOpenApi (this Microsoft.Extensions.DependencyInjection.IServiceCollection services, string documentName);static member AddOpenApi : Microsoft.Extensions.DependencyInjection.IServiceCollection * string -> Microsoft.Extensions.DependencyInjection.IServiceCollection<Extension()>
Public Function AddOpenApi (services As IServiceCollection, documentName As String) As IServiceCollectionParameters
- services
- IServiceCollection
The IServiceCollection to register services onto.
- documentName
- String
The name of the OpenAPI document associated with registered services.
Returns
Applies to
AddOpenApi(IServiceCollection, String, Action<OpenApiOptions>)
Adds OpenAPI services related to the given document name to the specified IServiceCollection with the specified options.
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddOpenApi (this Microsoft.Extensions.DependencyInjection.IServiceCollection services, string documentName, Action<Microsoft.AspNetCore.OpenApi.OpenApiOptions> configureOptions);static member AddOpenApi : Microsoft.Extensions.DependencyInjection.IServiceCollection * string * Action<Microsoft.AspNetCore.OpenApi.OpenApiOptions> -> Microsoft.Extensions.DependencyInjection.IServiceCollection<Extension()>
Public Function AddOpenApi (services As IServiceCollection, documentName As String, configureOptions As Action(Of OpenApiOptions)) As IServiceCollectionParameters
- services
- IServiceCollection
The IServiceCollection to register services onto.
- documentName
- String
The name of the OpenAPI document associated with registered services.
- configureOptions
- Action<OpenApiOptions>
A delegate used to configure the target OpenApiOptions.