Microsoft.AspNetCore.Mvc.ApiExplorer Espacio de nombres
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Proporciona tipos que permiten detectar metadatos, como la lista de controladores y acciones, y sus direcciones URL. Estos tipos son útiles para la eliminación de API mediante OpenAPI.
Clases
| Nombre | Description |
|---|---|
| ApiConventionNameMatchAttribute |
Determina el comportamiento coincidente de un método de convención de API o un parámetro por nombre. ApiConventionNameMatchBehavior para las opciones admitidas. <seealso cref="T:Microsoft. AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>. |
| ApiConventionResult |
Metadatos asociados a un método de acción a través de una convención de API. |
| ApiConventionTypeMatchAttribute |
Determina el comportamiento coincidente de un parámetro de convención de API por tipo. ApiConventionTypeMatchBehavior para las opciones admitidas. <seealso cref="T:Microsoft. AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>. |
| ApiDescription |
Representa una API expuesta por esta aplicación. |
| ApiDescriptionExtensions |
Métodos de extensión para ApiDescription. |
| ApiDescriptionGroup |
Representa un grupo de API relacionadas. |
| ApiDescriptionGroupCollection |
Colección almacenada en caché de ApiDescriptionGroup. |
| ApiDescriptionGroupCollectionProvider |
Proporciona acceso a una colección de ApiDescriptionGroup. |
| ApiDescriptionProviderContext |
Objeto de contexto para ApiDescription proveedores. |
| ApiParameterDescription |
Descripción de metadatos de una entrada en una API. |
| ApiParameterRouteInfo |
Una descripción de metadatos de la información de enrutamiento de .ApiParameterDescription |
| ApiRequestFormat |
Un formato posible para el cuerpo de una solicitud. |
| ApiResponseFormat |
Formato posible para .ApiResponseType |
| ApiResponseType |
Tipo posible del cuerpo de la respuesta con formato ApiResponseFormats. |
| DefaultApiDescriptionProvider |
Implementa un proveedor de ApiDescription para las acciones representadas por ControllerActionDescriptor. |
Interfaces
| Nombre | Description |
|---|---|
| IApiDefaultResponseMetadataProvider |
Proporciona un tipo de valor devuelto para todos los códigos de estado HTTP que no están cubiertos por otras IApiResponseMetadataProvider instancias. |
| IApiDescriptionGroupCollectionProvider |
Proporciona acceso a una colección de ApiDescriptionGroup. |
| IApiDescriptionGroupNameProvider |
Representa los metadatos de nombre de grupo de un |
| IApiDescriptionProvider |
Define un contrato para especificar ApiDescription instancias. |
| IApiDescriptionVisibilityProvider |
Representa los metadatos de visibilidad de un |
| IApiRequestFormatMetadataProvider |
Proporciona información de metadatos sobre el formato de solicitud a . |
| IApiRequestMetadataProvider |
Proporciona un conjunto de posibles tipos de contenido que la acción puede consumir. |
| IApiResponseMetadataProvider |
Proporciona un tipo de valor devuelto, un código de estado y un conjunto de posibles tipos de contenido devueltos por una ejecución correcta de la acción. |
| IApiResponseTypeMetadataProvider |
Proporciona información de metadatos sobre el formato de respuesta a . |
Enumeraciones
| Nombre | Description |
|---|---|
| ApiConventionNameMatchBehavior |
Comportamiento para hacer coincidir el nombre de un parámetro o método de convención. |
| ApiConventionTypeMatchBehavior |
Comportamiento para buscar coincidencias con el tipo de un parámetro de convención. |
Comentarios
Para obtener una introducción a Swagger (OpenAPI), ASP.NET Core documentación de api web con Swagger/OpenAPI.