Microsoft.AspNetCore.Mvc.ApiExplorer 命名空间

提供允许发现元数据的类型,例如控制器和操作列表及其 URL。 这些类型对于使用 OpenAPI 的 API 的 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) 简介,ASP.NET Core使用 Swagger/OpenAPI 的 Web API 文档