OpenApiOptions 클래스

정의

네임스페이스:

Microsoft.AspNetCore.OpenApi

어셈블리:

Microsoft.AspNetCore.OpenApi.dll

패키지:

Microsoft.AspNetCore.OpenApi v9.0.0-preview.6.24328.4

Source:

OpenApiOptions.cs

OpenAPI 문서 생성을 지원하는 옵션입니다.

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

상속

Object

OpenApiOptions

생성자

OpenApiOptions()

기본 ShouldInclude 조건자를 사용하여 OpenApiOptions 클래스의 새 인스턴스를 초기화합니다.

속성

DocumentName	이 OpenApiOptions 인스턴스가 연결된 OpenAPI 문서의 이름입니다.
OpenApiVersion	사용할 OpenAPI 사양의 버전입니다. 기본값은 OpenApi3_0.
ShouldInclude	지정된 ApiDescription 지정된 OpenAPI 문서에 포함해야 하는지 여부를 결정하는 대리자입니다.

메서드

UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	지정된 대리자를 현재 OpenApiOptions 인스턴스에서 작업 변환기로 등록합니다.
UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	지정된 대리자를 현재 OpenApiOptions 인스턴스에 스키마 변환기로 등록합니다.
UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	현재 OpenApiOptions 인스턴스에서 지정된 대리자를 문서 변환기로 등록합니다.
UseTransformer(IOpenApiDocumentTransformer)	현재 OpenApiOptions 인스턴스에 지정된 IOpenApiDocumentTransformer 인스턴스를 등록합니다.
UseTransformer<TTransformerType>()	현재 OpenApiOptions 인스턴스에 새 문서 변환기를 등록합니다.