OpenApiEndpointRouteBuilderExtensions.MapOpenApi Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.OpenApi.dll
Package:
Microsoft.AspNetCore.OpenApi v9.0.0-rc.2.24474.3
Source:
OpenApiEndpointRouteBuilderExtensions.cs

Register an endpoint onto the current application for resolving the OpenAPI document associated with the current application.

public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapOpenApi (this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string pattern = "/openapi/{documentName}.json");
static member MapOpenApi : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder * string -> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder
<Extension()>
Public Function MapOpenApi (endpoints As IEndpointRouteBuilder, Optional pattern As String = "/openapi/{documentName}.json") As IEndpointConventionBuilder

Parameters

endpoints
IEndpointRouteBuilder

The IEndpointRouteBuilder.

pattern
String

The route to register the endpoint on. Must include the 'documentName' route parameter.

Returns

IEndpointConventionBuilder

An IEndpointRouteBuilder that can be used to further customize the endpoint.

Applies to