create api docs
Generate OpenAPI 3 documentation for Payload CMS.
Installation
pnpm add create-payload-api-docs About
Create payload api docs is a command-line interface tool designed for generating OpenAPI 3 documentation for Payload CMS. Users can run the CLI command to automatically produce comprehensive API documentation in a structured format. This tool utilizes the payload-openapi package, which can also be used programmatically for documentation generation. With its straightforward usage, developers can integrate this tool into their build pipeline by adding it as a dev dependency, ensuring that documentation stays updated with the codebase. The plugin supports various configuration options allowing flexibility in how the documentation is generated. Alternatives include directly using payload-openapi for programmatic documentation generation or the payload-swagger package for a more user-friendly integration with Swagger.
Package info
- Package name
create-payload-api-docs- Latest version
1.4.0- Unpacked size
- 14 kB
- License
- MIT
- Weekly downloads
- 14
- Last publish
- Jul 15, 2023
More from teunmooij
View profileRBAC
Adds role-based access control to your Payload CMS.
Query
Type-safe query filters and field selection for Payload, with a REST select parameter plugin.
Swagger
Swagger plugin for Payload CMS that generates OpenAPI documentation.
OpenAPI
Generate OpenAPI 3 documentation for Payload CMS endpoints.
Similar plugins
More in ContentIframe Tabs
Add iframes into separate tabs in the Payload admin panel.
Relationship Enhancer
Enhances relationships in Payload CMS with referential integrity and bi-directional support.
Comment
Adds a customizable Comments collection to Payload CMS for user feedback.
Visual Editor
Adds a visual live editor to Payload CMS for instant content preview.
Author Fields
Adds created and updated by fields to collections and globals in Payload CMS.
Kanban Board
A kanban board plugin for managing tasks in Payload CMS.