Create openapi docs for your payload cms
npm install create-payload-api-docs
CLI for generating openAPI 3 documentation for your payload cms.
Alternatives:
- payload-openapi: to programmatically generate the openapi documentation
- payload-swagger: easy to use swagger payload plugin
Run the following command from your payload repository root folder:
``shell`
npx create-payload-api-docs
Or use the commandline option. To learn more:
`shell`
npx create-payload-api-docs --help
If you intend to use this package in your build pipeline, it is recommended to add it to your repo as a dev dependency, to prevent duplicate dependency downloads.
`shell`
npm i --save-dev create-payload-api-docs
create-payload-api-docs` uses payload-openapi to generate the documentation. For more information about the available options, see payload-openapi documentation.
See changelog