Microsoft.AspNetCore.Mvc.ApiExplorer 命名空間

提供類型，允許發現元資料，例如控制器與動作的清單，以及它們的網址。 這些類型對於使用 OpenAPI 來記錄 API 很有用。

類別

名稱 Description
ApiConventionNameMatchAttribute

以名稱決定與 API 慣例、方法或參數的匹配行為。 ApiConventionNameMatchBehavior 支援選項。 <參見 cref=“T：Microsoft。AspNetCore.Mvc.ApiConventionTypeAttribute“></seealso>.
ApiConventionResult

透過 API 慣例與動作方法相關的元資料。
ApiConventionTypeMatchAttribute

根據類型決定與 API 慣例參數的匹配行為。 ApiConventionTypeMatchBehavior 支援選項。 <參見 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

為 所代表ControllerActionDescriptor的行動實作 的ApiDescription提供者。

介面

名稱 Description
IApiDefaultResponseMetadataProvider

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

提供存取集合的 ApiDescriptionGroup。
IApiDescriptionGroupNameProvider

代表 的 ApiDescription群組名稱元資料。
IApiDescriptionProvider

定義了一種用於具體實 ApiDescription 例的契約。
IApiDescriptionVisibilityProvider

代表 的可見性元資料 ApiDescription。
IApiRequestFormatMetadataProvider

提供關於請求格式的元資料資訊給 IApiDescriptionProvider。
IApiRequestMetadataProvider

提供一組可能的內容類型，讓動作可以被消費。
IApiResponseMetadataProvider

提供回傳類型、狀態碼及一組由成功執行動作後回傳的內容類型。
IApiResponseTypeMetadataProvider

提供關於回應格式的元資料資訊。IApiDescriptionProvider

列舉

名稱 Description
ApiConventionNameMatchBehavior

匹配慣例參數或方法名稱的行為。
ApiConventionTypeMatchBehavior

匹配慣例參數類型時的行為。

備註

關於 Swagger（OpenAPI）的入門，ASP.NET Core 網頁 API 文件，包含 Swagger / OpenAPI。