Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (yak-create-payload-api-docs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

How to use

Run the following command from your payload repository root folder:

npx create-payload-api-docs

Or use the commandline option. To learn more:

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.

npm i --save-dev create-payload-api-docs

More configuration options

create-payload-api-docs uses payload-openapi to generate the documentation. For more information about the available options, see payload-openapi documentation.

Version history

See changelog