OpenAPI
Generiert OpenAPI-Spezifikationen aus Payload CMS-Konfigurationen.
Installation
pnpm add @seshuk/payload-plugin-openapi Über
Dieses Plugin erstellt OpenAPI 3.0, 3.1 und 3.2 Spezifikationen direkt aus einer Payload CMS-Konfiguration. Es ermöglicht die Dokumentation von Sammlungen, Globals, Authentifizierung, Versionen und Jobs ohne zusätzliche Anmerkungen. Nutzer können gezielt steuern, welche Entitäten und Operationen veröffentlicht werden, und einzelne Feldschemata durch `custom.openapi`-Metadaten verfeinern. Eingebaute Lokalisierung für Beschreibungen und Unterstützung für Benutzeroberflächen bieten interaktive Dokumentation über Scalar oder Swagger UI. Das Plugin bietet Flexibilität beim Bereitstellen der OpenAPI-Spezifikation und kann Dokumentationsdateien für die CI-Integration und die Generierung von Client-Code erzeugen. Es ist erforderlich, dass Payload in der Version 3.53.0 und Node.js 20 oder höher verwendet wird. Wichtige Optionen sind der API-Titel, die Version und die Möglichkeit, auszuwählen, welche Entitäten in der generierten Dokumentation erscheinen.
Paketinformationen
- Paketname
@seshuk/payload-plugin-openapi- Neueste Version
0.2.3- Entpackte Größe
- 469 kB
- Lizenz
- MIT
- Wöchentliche Downloads
- 1559
- Zuletzt veröffentlicht
- 8. Okt. 2026
Mehr von maximseshuk
Profil ansehenJanitor
Findet verwaiste Uploads und unreferenzierte Dokumente in Payload-Storage und löscht nur die freigegebenen Einträge.
Sitemap
Erzeugt sitemap.xml aus Payload-Collections und statischen URLs und legt die Dateien im Storage-Adapter des Projekts ab.
Shared plugin tooling
Dev-only Konfiguration für Linting, Formatierung, TypeScript, Build, Testdatenbank und Release der @seshuk Payload-Plugins.
Bunny Storage Adapter
Bunny.net-Speicher- und Stream-Adapter für Payload CMS mit TUS-Resumable-Uploads und CDN-Cache-Purging.
Media Preview
Bietet die Vorschau von Bildern, Videos, Audio und Dokumenten direkt im Payload CMS Admin-Panel.
Ähnliche Plugins
Mehr in DevtoolsPuck visual page builder
Integriert den Puck visuell Page Builder mit Payload CMS für Drag-and-Drop-Bearbeitung.
Create Ideal CMS
Interaktive CLI, die ein Payload-CMS-Monorepo mit vorkonfigurierten FocusReactive-Plugins aufsetzt.
OpenAPI
Erstellt automatisch eine OpenAPI-Spezifikation aus einer Payload CMS 3.x-Konfiguration und stellt sie über Scalar, Swagger UI, RapiDoc oder Redoc dar.
Markdown documentation sync
Synchronisiert Markdown-Dokumentation mit Payload CMS und Git.
Dry Run
Testet Create-Operationen in Payload CMS komplett durch, bricht nach Validierung und Hooks die Datenbanktransaktion ab.