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
- 13
- Last publish
- Jul 15, 2023
More from teunmooij
View profileSwagger
Swagger plugin for Payload CMS that generates OpenAPI documentation.
OpenAPI
Generate OpenAPI 3 documentation for Payload CMS endpoints.
Query
Type-safe query filters and field selection for Payload, with a REST select parameter plugin.
RBAC
Adds role-based access control to your Payload CMS.
Similar plugins
More in ContentCollaborative Comments
Adds document-level and field-level comments to the Payload admin panel, with @mentions, email notifications, resolution, multi-tenancy and locale filtering.
Dub
A Payload CMS plugin that automatically creates and manages shortlinks using Dub.
Nested Docs Page Tree
Adds a nested tree view for managing documents in Payload CMS.
Puck visual page builder
Integrate Puck visual page builder with Payload CMS for drag-and-drop editing.
Structured Markdown
Enables structured Markdown editing and rendering with advanced authoring features.
A/B Testing
A/B testing plugin that creates page variants in Payload collections and routes traffic at the edge via Next.js middleware.