Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Die OpenAPI-Spezifikation ist ein gegenüber der Programmiersprache agnostischer Standard zum Dokumentieren von HTTP-APIs. Der Daten-API-Generator unterstützt den OpenAPI-Standard mit folgenden Möglichkeiten:
- Generieren Sie Informationen zu allen durch die Laufzeitkonfiguration definierten Entitäten, die REST aktiviert sind.
- Kompilieren Sie die Informationen in ein Format, das dem OpenAPI-Schema entspricht.
- Macht das generierte OpenAPI-Schema über eine visuelle Benutzeroberfläche (Swagger) oder eine serialisierte Datei verfügbar.
OpenAPI-Beschreibungsdokument
Der Daten-API-Generator generiert ein OpenAPI-Beschreibungsdokument unter Verwendung der bereitgestellten Laufzeitkonfiguration und der Datenbankobjektmetadaten für jede definierte REST-aktivierte Entität. Die Schemadatei wird mithilfe von Funktionen generiert, die vom OpenAPI.NET SDK bereitgestellt werden. Derzeit wird die Schemadatei gemäß der OpenAPI-Spezifikation v3.0.1 generiert, die als JSON formatiert ist.
Das OpenAPI-Beschreibungsdokument kann aus dem Daten-API-Generator aus dem Pfad abgerufen werden:
GET /{rest-path}/openapi
Hinweis
Standardmäßig ist api der rest-path Wert und konfigurierbar. Weitere Informationen finden Sie unter REST-Konfiguration.
SwaggerUI
Die Swagger-Benutzeroberfläche ist eine webbasierte Benutzeroberfläche, die anhand der generierten OpenAPI-Spezifikation Informationen über den Dienst bereitstellt.
Im Development Modus ermöglicht der Daten-API-Generator das Anzeigen des generierten OpenAPI-Beschreibungsdokuments von einem dedizierten Endpunkt:
GET /swagger
Der Endpunkt "Swagger" ist nicht unter der rest-path geschachtelt, um Namenskonflikte mit laufzeitkonfigurierten Entitäten zu vermeiden.