Microsoft.AspNetCore.Mvc.ApiExplorer 네임스페이스
중요
일부 정보는 릴리스되기 전에 상당 부분 수정될 수 있는 시험판 제품과 관련이 있습니다. Microsoft는 여기에 제공된 정보에 대해 어떠한 명시적이거나 묵시적인 보증도 하지 않습니다.
컨트롤러 및 작업 목록 및 해당 URL과 같은 메타데이터를 검색할 수 있는 형식을 제공합니다. 이러한 형식은 OpenAPI를 사용하여 API를 수행하는 데 유용합니다.
클래스
| Name | Description |
|---|---|
| ApiConventionNameMatchAttribute |
이름별로 API 규칙 메서드 또는 매개 변수와 일치하는 동작을 결정합니다. ApiConventionNameMatchBehavior 지원되는 옵션의 경우 <seealso cref="T:Microsoft. AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>. |
| ApiConventionResult |
API 규칙을 통해 작업 메서드와 연결된 메타데이터입니다. |
| ApiConventionTypeMatchAttribute |
형식별로 API 규칙 매개 변수와 일치하는 동작을 결정합니다. ApiConventionTypeMatchBehavior 지원되는 옵션의 경우 <seealso cref="T:Microsoft. AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>. |
| ApiDescription |
이 애플리케이션에서 노출하는 API를 나타냅니다. |
| ApiDescriptionExtensions |
에 대한 ApiDescription확장 메서드 |
| ApiDescriptionGroup |
관련 API 그룹을 나타냅니다. |
| ApiDescriptionGroupCollection |
캐시된 .의 컬렉션입니다 ApiDescriptionGroup. |
| ApiDescriptionGroupCollectionProvider |
의 ApiDescriptionGroup컬렉션에 대한 액세스를 제공합니다. |
| ApiDescriptionProviderContext |
공급자에 대한 ApiDescription 컨텍스트 개체입니다. |
| ApiParameterDescription |
API에 대한 입력에 대한 메타데이터 설명입니다. |
| ApiParameterRouteInfo |
에 대한 라우팅 정보에 대한 메타데이터 설명입니다 ApiParameterDescription. |
| ApiRequestFormat |
요청 본문에 사용할 수 있는 형식입니다. |
| ApiResponseFormat |
에 사용할 수 있는 형식입니다 ApiResponseType. |
| ApiResponseType |
에 의해 ApiResponseFormats형식이 지정된 응답 본문의 가능한 형식입니다. |
| DefaultApiDescriptionProvider |
로 표시되는 작업에 대한 공급자 ApiDescription 를 ControllerActionDescriptor구현합니다. |
인터페이스
| Name | Description |
|---|---|
| IApiDefaultResponseMetadataProvider |
다른 IApiResponseMetadataProvider 인스턴스에서 다루지 않는 모든 HTTP 상태 코드에 대한 반환 형식을 제공합니다. |
| IApiDescriptionGroupCollectionProvider |
의 ApiDescriptionGroup컬렉션에 대한 액세스를 제공합니다. |
| IApiDescriptionGroupNameProvider |
에 대한 그룹 이름 메타데이터를 |
| IApiDescriptionProvider |
인스턴스를 지정하기 ApiDescription 위한 계약을 정의합니다. |
| IApiDescriptionVisibilityProvider |
에 대한 표시 유형 메타데이터를 |
| IApiRequestFormatMetadataProvider |
요청 형식에 대한 메타데이터 정보를 .에 |
| IApiRequestMetadataProvider |
작업에서 사용할 수 있는 것보다 가능한 콘텐츠 형식 집합을 제공합니다. |
| IApiResponseMetadataProvider |
동작을 성공적으로 실행하여 반환되는 반환 형식, 상태 코드 및 가능한 콘텐츠 형식 집합을 제공합니다. |
| IApiResponseTypeMetadataProvider |
에 응답 형식 |
열거형
| Name | Description |
|---|---|
| ApiConventionNameMatchBehavior |
규칙 매개 변수 또는 메서드의 이름을 일치시키는 동작입니다. |
| ApiConventionTypeMatchBehavior |
규칙 매개 변수의 형식을 일치시키는 동작입니다. |
설명
Swagger/OpenAPI Swagger(OpenAPI)