Microsoft.AspNetCore.Mvc.ApiExplorer 命名空間

提供類型,允許探索中繼資料,例如控制器和動作的清單及其 URL。 這些類型對於使用 OpenAPI 的 DOcumeting API 很有用。

類別

ApiConventionNameMatchAttribute

依名稱決定 API 慣例方法或參數的比對行為。 ApiConventionNameMatchBehavior 支援的選項。 .

ApiConventionResult

透過 API 慣例與動作方法相關聯的中繼資料。

ApiConventionTypeMatchAttribute

依類型判斷 API 慣例參數的比對行為。 ApiConventionTypeMatchBehavior 支援的選項。 .

ApiDescription

表示此應用程式所公開的 API。

ApiDescriptionExtensions

ApiDescription 的擴充方法。

ApiDescriptionGroup

表示相關 API 的群組。

ApiDescriptionGroupCollection

ApiDescriptionGroup 快取集合。

ApiDescriptionGroupCollectionProvider

提供 集合的 ApiDescriptionGroup 存取權。

ApiDescriptionProviderContext

提供者的內容物件 ApiDescription

ApiParameterDescription

API 輸入的中繼資料描述。

ApiParameterRouteInfo

的路由資訊的 ApiParameterDescription 中繼資料描述。

ApiRequestFormat

要求主體的可能格式。

ApiResponseFormat

ApiResponseType 可能格式。

ApiResponseType

回應本文的可能類型,其格式為 ApiResponseFormats

DefaultApiDescriptionProvider

針對 所表示的動作實作 的 ControllerActionDescriptor 提供者 ApiDescription

介面

IApiDefaultResponseMetadataProvider

提供其他 IApiResponseMetadataProvider 實例未涵蓋之所有 HTTP 狀態碼的傳回類型。

IApiDescriptionGroupCollectionProvider

提供 集合的 ApiDescriptionGroup 存取權。

IApiDescriptionGroupNameProvider

表示 的 ApiDescription 組名中繼資料。

IApiDescriptionProvider

定義指定實例的 ApiDescription 合約。

IApiDescriptionVisibilityProvider

表示 的 ApiDescription 可見度中繼資料。

IApiRequestFormatMetadataProvider

將要求格式的相關中繼資料資訊提供給 IApiDescriptionProvider

IApiRequestMetadataProvider

提供一組可能的內容類型,而不是動作所取用的。

IApiResponseMetadataProvider

提供成功執行動作所傳回的傳回型別、狀態碼和一組可能的內容類型。

IApiResponseTypeMetadataProvider

提供有關 回應格式的 IApiDescriptionProvider 中繼資料資訊。

列舉

ApiConventionNameMatchBehavior

比對慣例參數或方法名稱的行為。

ApiConventionTypeMatchBehavior

比對慣例參數類型的行為。

備註

如需 Swagger (OpenAPI) 簡介,請使用 Swagger / OpenAPI ASP.NET Core Web API 檔