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
- 11
- 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 ContentMenus
Adds a menus collection to Payload for building navigation with nested items, collection links, custom URLs, icons, and preview images.
Reservation and Booking Manager
Manage reservations and bookings through Payload CMS with conflict detection and scheduling.
Live Preview
Live preview for Payload CMS in Astro and any SSR/static frontend (SvelteKit, Nuxt, Next.js, plain HTML), patching the DOM without rebuilds.
FixedLink
Adds short links on your own domain to Payload documents, with links that keep working after slug changes through the FixedLink service.
Nested Docs Page Tree
Adds a nested tree view for managing documents in Payload CMS.
A/B Testing
A/B testing plugin that creates page variants in Payload collections and routes traffic at the edge via Next.js middleware.