OpenApiOptions 클래스

정의

네임스페이스:
Microsoft.AspNetCore.OpenApi
어셈블리:
Microsoft.AspNetCore.OpenApi.dll
패키지:
Microsoft.AspNetCore.OpenApi v10.0.0
패키지:
Microsoft.AspNetCore.OpenApi v11.0.0-preview.3.26207.106
패키지:
Microsoft.AspNetCore.OpenApi v9.0.8
Source:
OpenApiOptions.cs
Source:
OpenApiOptions.cs
Source:
OpenApiOptions.cs

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

public sealed class OpenApiOptions
type OpenApiOptions = class
Public NotInheritable Class OpenApiOptions
상속
Object
OpenApiOptions

생성자

Name Description
OpenApiOptions()

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

속성

Name Description
CreateSchemaReferenceId

지정된 OpenAPI 문서의 형식과 연결된 스키마에 대한 참조 ID를 만드는 방법을 결정하는 대리자입니다.
DocumentName

이 OpenApiOptions 인스턴스가 연결된 OpenAPI 문서의 이름입니다.
OpenApiVersion

사용할 OpenAPI 사양의 버전입니다. 기본값은 OpenApi3_1입니다.
ShouldInclude

지정된 OpenAPI 문서에 지정된 ApiDescription 문서를 포함해야 하는지 여부를 결정하는 대리자입니다.

메서드

Name Description
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

지정된 대리자를 현재 OpenApiOptions 인스턴스의 문서 변환기로 등록합니다.
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

지정된 대리자를 현재 OpenApiOptions 인스턴스의 문서 변환기로 등록합니다.
AddDocumentTransformer(IOpenApiDocumentTransformer)

현재 OpenApiOptions 인스턴스의 지정된 인스턴스 IOpenApiDocumentTransformer 를 등록합니다.
AddDocumentTransformer<TTransformerType>()

현재 OpenApiOptions 인스턴스에 새 문서 변환기를 등록합니다.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

지정된 대리자를 현재 OpenApiOptions 인스턴스에서 작업 변환기로 등록합니다.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

지정된 대리자를 현재 OpenApiOptions 인스턴스에서 작업 변환기로 등록합니다.
AddOperationTransformer(IOpenApiOperationTransformer)

현재 OpenApiOptions 인스턴스의 지정된 인스턴스 IOpenApiOperationTransformer 를 등록합니다.
AddOperationTransformer<TTransformerType>()

현재 OpenApiOptions 인스턴스에 새 작업 변환기를 등록합니다.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

지정된 대리자를 현재 OpenApiOptions 인스턴스에서 스키마 변환기로 등록합니다.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

지정된 대리자를 현재 OpenApiOptions 인스턴스에서 스키마 변환기로 등록합니다.
AddSchemaTransformer(IOpenApiSchemaTransformer)

현재 OpenApiOptions 인스턴스의 지정된 인스턴스 IOpenApiOperationTransformer 를 등록합니다.
AddSchemaTransformer<TTransformerType>()

현재 OpenApiOptions 인스턴스에 새 스키마 변환기를 등록합니다.
CreateDefaultSchemaReferenceId(JsonTypeInfo)

지정된 JsonTypeInfo스키마에 대한 스키마 참조 ID를 만들기 위한 기본 구현입니다.

적용 대상