Microsoft.AspNetCore.Mvc.ApiExplorer Espace de noms
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Fournit des types qui permettent de découvrir des métadonnées telles que la liste des contrôleurs et des actions, ainsi que leurs URL. Ces types sont utiles pour les API de documeting à l’aide d’OpenAPI.
Classes
| Nom | Description |
|---|---|
| ApiConventionNameMatchAttribute |
Détermine le comportement correspondant d’une méthode ou d’un paramètre de convention d’API par nom. ApiConventionNameMatchBehavior pour les options prises en charge. <seealso cref="T :Microsoft. AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>. |
| ApiConventionResult |
Métadonnées associées à une méthode d’action via une convention d’API. |
| ApiConventionTypeMatchAttribute |
Détermine le comportement correspondant d’un paramètre de convention d’API par type. ApiConventionTypeMatchBehavior pour les options prises en charge. <seealso cref="T :Microsoft. AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>. |
| ApiDescription |
Représente une API exposée par cette application. |
| ApiDescriptionExtensions |
Méthodes d’extension pour ApiDescription. |
| ApiDescriptionGroup |
Représente un groupe d’API associées. |
| ApiDescriptionGroupCollection |
Collection mise en cache de ApiDescriptionGroup. |
| ApiDescriptionGroupCollectionProvider |
Fournit l’accès à une collection de ApiDescriptionGroup. |
| ApiDescriptionProviderContext |
Objet de contexte pour ApiDescription les fournisseurs. |
| ApiParameterDescription |
Description des métadonnées d’une entrée dans une API. |
| ApiParameterRouteInfo |
Description des métadonnées des informations de routage d’un ApiParameterDescription. |
| ApiRequestFormat |
Format possible pour le corps d’une requête. |
| ApiResponseFormat |
Format possible pour un ApiResponseType. |
| ApiResponseType |
Type possible du corps de la réponse mis en forme par ApiResponseFormats. |
| DefaultApiDescriptionProvider |
Implémente un fournisseur d’actions ApiDescription représentées par ControllerActionDescriptor. |
Interfaces
| Nom | Description |
|---|---|
| IApiDefaultResponseMetadataProvider |
Fournit un type de retour pour tous les codes d’état HTTP qui ne sont pas couverts par d’autres IApiResponseMetadataProvider instances. |
| IApiDescriptionGroupCollectionProvider |
Fournit l’accès à une collection de ApiDescriptionGroup. |
| IApiDescriptionGroupNameProvider |
Représente les métadonnées de nom de groupe d’un |
| IApiDescriptionProvider |
Définit un contrat pour spécifier des ApiDescription instances. |
| IApiDescriptionVisibilityProvider |
Représente les métadonnées de visibilité d’un |
| IApiRequestFormatMetadataProvider |
Fournit des informations de métadonnées sur le format de requête à un |
| IApiRequestMetadataProvider |
Fournit un ensemble de types de contenu possibles que ceux qui peuvent être consommés par l’action. |
| IApiResponseMetadataProvider |
Fournit un type de retour, un code d’état et un ensemble de types de contenu possibles retournés par une exécution réussie de l’action. |
| IApiResponseTypeMetadataProvider |
Fournit des informations de métadonnées sur le format de réponse à un |
Énumérations
| Nom | Description |
|---|---|
| ApiConventionNameMatchBehavior |
Comportement correspondant au nom d’un paramètre ou d’une méthode de convention. |
| ApiConventionTypeMatchBehavior |
Comportement de mise en correspondance du type d’un paramètre de convention. |
Remarques
Pour une présentation de Swagger (OpenAPI), ASP.NET Core documentation de l’API web avec Swagger / OpenAPI.