Microsoft.AspNetCore.Mvc.ApiExplorer 命名空间
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
提供允许发现元数据的类型,例如控制器和操作列表及其 URL。 这些类型对于使用 OpenAPI 的 documeting API 非常有用。
类
| 名称 | 说明 |
|---|---|
| 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 |
实现表示的操作ControllerActionDescriptor的ApiDescription提供程序。 |
接口
| 名称 | 说明 |
|---|---|
| IApiDefaultResponseMetadataProvider |
为其他 IApiResponseMetadataProvider 实例未涵盖的所有 HTTP 状态代码提供返回类型。 |
| IApiDescriptionGroupCollectionProvider |
提供对集合 ApiDescriptionGroup的访问权限。 |
| IApiDescriptionGroupNameProvider |
表示组 |
| IApiDescriptionProvider |
定义用于指定 ApiDescription 实例的协定。 |
| IApiDescriptionVisibilityProvider |
表示 . 的 |
| IApiRequestFormatMetadataProvider |
提供有关请求格式的元数据信息。 |
| IApiRequestMetadataProvider |
提供比操作可以使用的一组可能的内容类型。 |
| IApiResponseMetadataProvider |
提供一个返回类型、状态代码和一组可能通过成功执行操作返回的内容类型。 |
| IApiResponseTypeMetadataProvider |
提供有关响应格式的 |
枚举
| 名称 | 说明 |
|---|---|
| ApiConventionNameMatchBehavior |
与约定参数或方法的名称匹配的行为。 |
| ApiConventionTypeMatchBehavior |
匹配约定参数类型的行为。 |
注解
有关 Swagger (OpenAPI)的简介,ASP.NET Core Web API 文档与 Swagger/OpenAPI。