Command-line generator that writes an OpenAPI 3 document
Swagger
Generates an OpenAPI 3 document and Swagger UI for every endpoint in a Payload config
Installation
pnpm add payload-swagger About
Swagger adds a browsable API reference to a Payload project. It reads collections, globals, custom endpoints and authentication routes and produces an OpenAPI 3 document describing them, including request bodies, parameters, typed responses and which operations require a logged-in user. A Swagger UI page renders that document so developers can read and try the API in the browser.
Descriptions and examples come from collection labels and admin descriptions, and custom endpoints can carry their own summaries and response schemas. Access rules are analysed to show who can call each operation, and parts of the API can be left out of the generated document.
Package info
- Package name
payload-swagger- Latest version
1.4.0- Unpacked size
- 24 kB
- License
- MIT
- Weekly downloads
- 1k
- Last publish
- Jul 15, 2023
More from teunmooij
View profileGenerates OpenAPI 3.0 documents for the REST endpoints of a Payload project
Type-safe filters, field selection and reusable queries
Role-based access control for user collections, with reusable access rules and query filters
Similar plugins
More in DevtoolsChat agent that composes and edits Payload pages from your block library
Exposes Payload collections and globals to AI agents through the Model Context Protocol
Lets AI assistants read and edit Payload content over MCP with scoped API keys
Editorial suite that lets teams run a Payload site through MCP tools and AI assistants
Typed block registry and React Server Component renderer for Payload blocks
Runs Payload CMS admin and APIs under vinext, on Node or Cloudflare Workers