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.1.0

Unpacked size

456 kB

License

MIT

Weekly downloads

19

Last publish

Jun 13, 2026