OpenAPI

Über

Das OpenAPI-Plugin für Payload CMS generiert Dokumentation für API-Endpunkte, die in einer Payload CMS-Anwendung definiert sind. Es unterstützt Sammlungsendpunkte, globale und benutzerdefinierte Endpunkte sowie Authentifizierungsanforderungen. Die erstellte Dokumentation ist vollständig typisiert, was eine präzise Darstellung von Anfragen, Antworten und Parametern gewährleistet. Zur Integration wird die Funktion `createDocument` verwendet, um die Konfiguration von Payload und optionale Parameter für eine benutzerdefinierte Ausgabe zu übergeben. Die Dokumentation kann zusätzliche OpenAPI-Details aus externen Quellen wie `package.json` und optionalen `.openapi`-Dateien übernehmen, um benutzerdefinierte Schemata zu kombinieren. Das Plugin ermöglicht eine umfassende Konfiguration, um bestimmte Pfade auszuschließen oder die Zugriffsanalyse für ausgewählte Sammlungen wegzulassen. Dieses Plugin ist ein nützliches Werkzeug für Entwickler, die ihre APIs genau dokumentieren und das Verständnis für ihre verfügbaren Endpunkte fördern möchten. Es erleichtert die Zusammenarbeit und Integration mit anderen Diensten.

Paketinformationen

Paketname

payload-openapi

Neueste Version

1.4.0

Entpackte Größe

109 kB

Lizenz

MIT

Wöchentliche Downloads

359

Zuletzt veröffentlicht

15. Juli 2023