create api docs

Über

Dieses Tool ist eine Schnittstelle für die Kommandozeile, die zur automatischen Generierung von OpenAPI 3-Dokumentation für Payload CMS dient. Durch das Ausführen des CLI-Befehls kann umfassende API-Dokumentation in einem strukturierten Format erstellt werden. Es nutzt das Paket payload-openapi, das auch programmatisch für die Dokumentationserstellung verwendet werden kann. Dank der einfachen Handhabung können Entwickler dieses Tool in ihre Build-Pipeline integrieren, indem sie es als Entwicklungsabhängigkeit hinzufügen. So bleibt die Dokumentation stets aktuell mit dem Code. Das Plugin bietet verschiedene Konfigurationsmöglichkeiten, um die Generierung der Dokumentation flexibel zu gestalten. Alternativen sind die direkte Verwendung von payload-openapi für die programmatische Dokumentationserstellung oder das Paket payload-swagger für eine benutzerfreundlichere Integration mit Swagger.

Paketinformationen

Paketname

create-payload-api-docs

Neueste Version

1.4.0

Entpackte Größe

14 kB

Lizenz

MIT

Wöchentliche Downloads

17

Zuletzt veröffentlicht

15. Juli 2023