Microsoft.AspNetCore.Mvc.ApiExplorer Namespace

Stellt Typen bereit, die das Ermitteln von Metadaten wie die Liste der Controller und Aktionen sowie deren URLs ermöglichen. Diese Typen sind nützlich für die Dokumentation von APIs mit OpenAPI.

Klassen

ApiConventionNameMatchAttribute	Bestimmt das übereinstimmende Verhalten einer API-Konventionsmethode oder eines -Parameters anhand des Namens. ApiConventionNameMatchBehavior für unterstützte Optionen. .
ApiConventionResult	Metadaten, die einer Aktionsmethode über die API-Konvention zugeordnet sind.
ApiConventionTypeMatchAttribute	Bestimmt das übereinstimmende Verhalten eines API-Konventionsparameters nach Typ. ApiConventionTypeMatchBehavior für unterstützte Optionen. .
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 Auflistung von ApiDescriptionGroup.
ApiDescriptionGroupCollectionProvider	Ermöglicht den Zugriff auf eine Auflistung von ApiDescriptionGroup.
ApiDescriptionProviderContext	Ein Kontextobjekt für ApiDescription Anbieter.
ApiParameterDescription	Eine Metadatenbeschreibung einer Eingabe an eine API.
ApiParameterRouteInfo	Eine Metadatenbeschreibung der Routinginformationen für einen 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 durch ApiResponseFormatsformatiert ist.
DefaultApiDescriptionProvider	Implementiert einen Anbieter von ApiDescription für Aktionen, die von dargestellt werden ControllerActionDescriptor.

Schnittstellen

IApiDefaultResponseMetadataProvider	Stellt einen Rückgabetyp für alle HTTP-status-Codes bereit, die nicht von anderen IApiResponseMetadataProvider Instanzen abgedeckt werden.
IApiDescriptionGroupCollectionProvider	Ermöglicht den Zugriff auf eine Auflistung von ApiDescriptionGroup.
IApiDescriptionGroupNameProvider	Stellt Gruppennamenmetadaten für ein ApiDescriptiondar.
IApiDescriptionProvider	Definiert einen Vertrag zum Angeben von ApiDescription Instanzen.
IApiDescriptionVisibilityProvider	Stellt Sichtbarkeitsmetadaten für eine dar ApiDescription.
IApiRequestFormatMetadataProvider	Stellt Metadateninformationen zum Anforderungsformat für ein bereit IApiDescriptionProvider.
IApiRequestMetadataProvider	Stellt eine Reihe möglicher Inhaltstypen bereit, die von der Aktion genutzt werden können.
IApiResponseMetadataProvider	Stellt einen Rückgabetyp, status Code und eine Reihe möglicher Inhaltstypen bereit, die durch eine erfolgreiche Ausführung der Aktion zurückgegeben werden.
IApiResponseTypeMetadataProvider	Stellt Metadateninformationen zum Antwortformat für ein IApiDescriptionProviderbereit.

Enumerationen

ApiConventionNameMatchBehavior	Das Verhalten für den Abgleich mit dem Namen eines Konventionsparameters oder einer -Methode.
ApiConventionTypeMatchBehavior	Das Verhalten für den Abgleich des Typs eines Konventionsparameters.

Hinweise

Für eine Einführung in Swagger (OpenAPI) ASP.NET Core Web-API-Dokumentation mit Swagger /OpenAPI.