Befehlszeilen-Generator, der ein OpenAPI-3-Dokument schreibt
API-Dokumentations-Tools für Payload CMS 2
OpenAPI-3-Generatoren für die REST-API von Payload CMS, dazu JSON-LD-Helfer für Frontend-Seiten und ein Audit, das ohne Login lesbare Daten findet.
Generiert OpenAPI-3.0-Dokumente für die REST-Endpunkte eines Payload-Projekts aus der Konfiguration
Über diese Pakete
API-Dokumentations-Tools erzeugen ein OpenAPI-3-Dokument für die REST-Endpunkte von Payload. Swagger UI, Redoc und Client-Generatoren können es lesen. Die Kategorie enthält außerdem Schema.org-Helfer für JSON-LD und ein Audit für öffentlich lesbare Daten.
Was diese Tools abdecken
- OpenAPI, ein Generator für OpenAPI-3.0-Dokumente der REST-Endpunkte
- Create API Docs, ein OpenAPI-3-Generator, der auch bei den CLI-Tools steht
- Specs für Swagger UI, Redoc oder einen Client-Generator
- SEO-JSON-LD-Helfer für Produkt-, Breadcrumb- und Listenseiten
- Security, ein Audit, das ohne Login lesbare Daten aufspürt
API-Dokumentations-Tools wählen
OpenAPI und Create API Docs sind eigenständige Generatoren. Prüfen Sie die unterstützte Payload-Version auf ihren Karten und testen Sie sie mit Ihrem Projekt, bevor Sie sich darauf verlassen. Die OpenAPI-Plugins unter den Entwickler-Plugins erzeugen die Spec dagegen innerhalb Ihrer App und liefern sie mit Swagger UI oder Scalar aus. Erzeugen Sie die Spec in jedem Fall neu, wenn sich Collections ändern, damit sie nicht von der API abweicht. Lassen Sie Security gegen eine Staging-Website laufen, um zu sehen, welche Daten jeder ohne Login lesen kann.
Häufig gestellte Fragen
Erzeugt Payload CMS selbst OpenAPI-Dokumentation?
Nein. Payload erzeugt TypeScript-Typen und ein GraphQL-Schema, aber keine OpenAPI-Spec für die REST-API. Nutzen Sie einen Generator aus dieser Kategorie oder ein OpenAPI-Plugin aus den Entwickler-Plugins.
Funktionieren diese OpenAPI-Generatoren mit meiner Payload-Version?
Prüfen Sie zuerst die unterstützte Payload-Version auf ihren Karten, denn beide sind ältere, eigenständige Pakete. Die OpenAPI-Plugins bei den Entwickler-Plugins lesen Ihre Konfiguration direkt in der App und folgen damit Ihrem Payload-Setup.
Kann ich aus der Spec einen API-Client erzeugen?
Ja. Jeder OpenAPI-Client-Generator kann sie lesen. Für TypeScript-Projekte ist das offizielle Payload SDK oft einfacher, weil es die REST-API von Payload bereits kennt.



