OpenAPI
Generate OpenAPI 3 documentation for Payload CMS endpoints.
Installation
pnpm add payload-openapi About
The OpenAPI for Payload CMS plugin creates comprehensive OpenAPI documentation for your API endpoints defined in a Payload CMS application. This includes support for collection endpoints, global and custom endpoints, and authentication requirements. The documentation generated is fully typed, ensuring accurate representation of requests, responses, and parameters. To integrate, use the `createDocument` function, passing your Payload configuration and optional parameters for customized output. Documentation can incorporate additional OpenAPI details from external sources like `package.json` and optional `.openapi` files for merging custom schemas. The plugin allows for extensive configuration to exclude specific paths or to omit access analysis for selected collections. This plugin serves as a valuable tool for developers looking to document their APIs accurately, promote understanding of their available endpoints, and facilitate easier collaboration and integration with other services.
Package info
- Package name
payload-openapi- Latest version
1.4.0- Unpacked size
- 109 kB
- License
- MIT
- Weekly downloads
- 401
- Last publish
- Jul 15, 2023
More from teunmooij
View profileSimilar plugins
More in DevtoolsPuck visual page builder
Integrate Puck visual page builder with Payload CMS for drag-and-drop editing.
OpenAPI
Generates OpenAPI specifications from Payload CMS configurations.
Create Ideal CMS
Interactive CLI that scaffolds a production-ready Payload CMS monorepo preconfigured with FocusReactive plugins.
OpenAPI
Autogenerate an OpenAPI specification from a Payload CMS instance and render it with Swagger UI, Redoc, RapiDoc, or Scalar.
Markdown documentation sync
Syncs Markdown documentation with Payload CMS using Git.
Dry Run
Test Payload create operations end-to-end without persisting, by rolling back the transaction after hooks and validation run.