Swagger

Über

Das Plugin generiert OpenAPI 3-Dokumentation basierend auf der Konfiguration von Payload. Es fügt Routen hinzu, um das OpenAPI-Dokument und die Swagger UI bereitzustellen, wodurch die Erkundung von API-Endpunkten erleichtert wird. Das Plugin nutzt das Paket payload-openapi, um alle verfügbaren Endpunkte wie Sammlungs-, globale, benutzerdefinierte und Authentifizierungsendpunkte zu dokumentieren und bietet typisierte Schema-Definitionen für Anfragen und Antworten. Die Konfiguration kann flexibel angepasst werden, um die Routen der Swagger UI zu optimieren, Zugriffsanalysen auf Sammlungen durchzuführen und benutzerdefinierte Endpunkte zu definieren. Bestimmte Teile der Konfiguration können von der Dokumentation ausgeschlossen werden. Beispiele für benutzerdefinierte Endpunkte können direkt in die Payload-Konfiguration integriert werden, und für benutzerdefinierte Routen kann ebenfalls Dokumentation hinzugefügt werden. Diese Integration ermöglicht eine umfassende Dokumentation komplexer Payload-APIs in Verbindung mit den Kerneigenschaften des CMS.

Paketinformationen

Paketname

payload-swagger

Neueste Version

1.4.0

Entpackte Größe

24 kB

Lizenz

MIT

Wöchentliche Downloads

292

Zuletzt veröffentlicht

15. Juli 2023