OpenAPI

Über

Das Plugin durchläuft die Payload-Konfiguration und erzeugt eine vollständige OpenAPI-Spezifikation. Sie umfasst Collection-CRUD, Global-CRUD, Auth-Endpunkte, Preferences und eigene Endpunkte. Die Ausgabe erfolgt wahlweise als OpenAPI 3.0 oder 3.1, wobei 3.1-Dokumente bei Bedarf nach 3.0 konvertiert werden. Die Spezifikation liegt an einem konfigurierbaren Endpunkt, standardmäßig unter `/api/openapi.json`. Auth-Collections werden entsprechend ihrer Auth-Konfiguration abgebildet. `disableLocalStrategy` entfernt die Password-Operationen, `loginWithUsername` verändert die Struktur des Login-Bodys und `maxLoginAttempts: 0` blendet den `/unlock`-Endpunkt aus. Ist `verify` aktiv, fügt das Plugin `/verify/{id}` hinzu. Eigene Endpunkte auf Collection-, Global- oder Config-Ebene werden erfasst, wenn sie unter `custom.openapi` eine OpenAPI-Operation definieren. Vom Generator werden `tags`, `operationId`, `summary` und `security` automatisch ergänzt, falls diese Felder fehlen. Mit den Filteroptionen `includeCollections`, `excludeCollections`, `includeGlobals`, `excludeGlobals` und `hideInternalCollections` lässt sich steuern, welche Collections und Globals in der Spezifikation auftauchen. Die Option `apiBasePath` überschreibt das Pfad-Präfix der generierten Operationen, was bei Reverse-Proxy-Setups mit abweichendem Prefix hilfreich ist. Für die Darstellung liefert das Paket separate UI-Plugins für Scalar, Swagger UI, RapiDoc und Redoc. Wird eines davon zusammen mit dem `openapi`-Plugin registriert, sind die Docs unter `/api/docs` erreichbar. Das Plugin ist in TypeScript geschrieben und hat `payload ^3.0.0` als Peer-Dependency.

Paketinformationen

Paketname

payload-oapi

Neueste Version

0.3.1

Entpackte Größe

189 kB

Lizenz

MIT

Wöchentliche Downloads

14.737

Zuletzt veröffentlicht

3. Okt. 2026