Microsoft.AspNetCore.Mvc.ApiExplorer Namespace
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt Typen bereit, mit denen Metadaten wie die Liste der Controller und Aktionen und deren URLs ermittelt werden können. Diese Typen sind nützlich für das Documeting von APIs mit OpenAPI.
Klassen
| Name | Beschreibung |
|---|---|
| ApiConventionNameMatchAttribute |
Bestimmt das übereinstimmende Verhalten einer API-Konventionsmethode oder eines Parameters anhand des Namens. ApiConventionNameMatchBehavior für unterstützte Optionen. <seealso cref="T:Microsoft. AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>. |
| ApiConventionResult |
Metadaten, die einer Aktionsmethode über API-Konvention zugeordnet sind. |
| ApiConventionTypeMatchAttribute |
Bestimmt das übereinstimmende Verhalten eines API-Konventionsparameters nach Typ. ApiConventionTypeMatchBehavior für unterstützte Optionen. <seealso cref="T:Microsoft. AspNetCore.Mvc.ApiConventionTypeAttribute"></seealso>. |
| ApiDescription |
Stellt eine API dar, die von dieser Anwendung verfügbar gemacht wird. |
| ApiDescriptionExtensions |
Erweiterungsmethoden für ApiDescription. |
| ApiDescriptionGroup |
Stellt eine Gruppe verwandter APIs dar. |
| ApiDescriptionGroupCollection |
Eine zwischengespeicherte Sammlung von ApiDescriptionGroup. |
| ApiDescriptionGroupCollectionProvider |
Bietet Zugriff auf eine Sammlung von ApiDescriptionGroup. |
| ApiDescriptionProviderContext |
Ein Kontextobjekt für ApiDescription Anbieter. |
| ApiParameterDescription |
Eine Metadatenbeschreibung einer Eingabe für eine API. |
| ApiParameterRouteInfo |
Eine Metadatenbeschreibung der Routinginformationen für ein ApiParameterDescription. |
| ApiRequestFormat |
Ein mögliches Format für den Textkörper einer Anforderung. |
| ApiResponseFormat |
Mögliches Format für ein ApiResponseType. |
| ApiResponseType |
Möglicher Typ des Antworttexts, der formatiert ist.ApiResponseFormats |
| DefaultApiDescriptionProvider |
Implementiert einen Anbieter für Aktionen, die ApiDescription durch dargestellt werden ControllerActionDescriptor. |
Schnittstellen
| Name | Beschreibung |
|---|---|
| IApiDefaultResponseMetadataProvider |
Stellt einen Rückgabetyp für alle HTTP-Statuscodes bereit, die nicht von anderen IApiResponseMetadataProvider Instanzen abgedeckt werden. |
| IApiDescriptionGroupCollectionProvider |
Bietet Zugriff auf eine Sammlung von ApiDescriptionGroup. |
| IApiDescriptionGroupNameProvider |
Stellt Gruppennamenmetadaten für ein |
| IApiDescriptionProvider |
Definiert einen Vertrag zum Angeben von ApiDescription Instanzen. |
| IApiDescriptionVisibilityProvider |
Stellt Sichtbarkeitsmetadaten für ein |
| IApiRequestFormatMetadataProvider |
Stellt Metadateninformationen zum Anforderungsformat für ein |
| IApiRequestMetadataProvider |
Stellt eine Reihe möglicher Inhaltstypen bereit, als von der Aktion genutzt werden können. |
| IApiResponseMetadataProvider |
Stellt einen Rückgabetyp, Statuscode und eine Reihe möglicher Inhaltstypen bereit, die von einer erfolgreichen Ausführung der Aktion zurückgegeben werden. |
| IApiResponseTypeMetadataProvider |
Stellt Metadateninformationen zum Antwortformat für ein |
Enumerationen
| Name | Beschreibung |
|---|---|
| ApiConventionNameMatchBehavior |
Das Verhalten für den Abgleich mit dem Namen eines Konventionsparameters oder einer Methode. |
| ApiConventionTypeMatchBehavior |
Das Verhalten für den Abgleich mit dem Typ eines Konventionsparameters. |
Hinweise
Eine Einführung in Swagger (OpenAPI), ASP.NET Core Web-API-Dokumentation mit Swagger / OpenAPI.