OpenAPI
Generates OpenAPI specifications from Payload CMS configurations.
Installation
pnpm add @seshuk/payload-plugin-openapi About
This plugin generates OpenAPI 3.0, 3.1, and 3.2 specifications directly from a Payload CMS setup. Users can document collections, globals, authentication, versions, and jobs without needing any annotations. The plugin supports exclusive control over exposed entities and operations and allows refined field schemas through `custom.openapi` metadata. With built-in localization for descriptions and UI support, interactive documentation is provided using Scalar or Swagger UI. It offers flexibility in serving the OpenAPI spec and can generate documentation files for CI integration and client code generation. The plugin requires Payload version 3.53.0 and Node.js 20 or higher. Essential options include the API title, version, and the ability to filter which entities appear in the generated documentation.
Package info
- Package name
@seshuk/payload-plugin-openapi- Latest version
0.2.0- Unpacked size
- 463 kB
- License
- MIT
- Weekly downloads
- 705
- Last publish
- Jul 13, 2026
More from maximseshuk
View profileSimilar plugins
More in DevtoolsOpenAPI
Autogenerate an OpenAPI specification from a Payload CMS instance and render it with Swagger UI, Redoc, RapiDoc, or Scalar.
Puck visual page builder
Integrate Puck visual page builder with Payload CMS for drag-and-drop editing.
Create Ideal CMS
Interactive CLI that scaffolds a production-ready Payload CMS monorepo preconfigured with FocusReactive plugins.
Dry Run
Test Payload create operations end-to-end without persisting, by rolling back the transaction after hooks and validation run.
Repository
Wrapper around Payload's Local API providing repository operations.
Markdown documentation sync
Syncs Markdown documentation with Payload CMS using Git.