Overview
Summary generated from the READMEA command line tool that generates OpenAPI 3 documentation for a Payload CMS project. It is run from the repository root with npx or added as a dev dependency for build pipelines. It relies on the payload-openapi package for generation, so that package's options apply. Targets Payload 1.x.
Features
- Generates OpenAPI 3 documentation from a Payload project
- Runs from the repository root through npx
- Supports command line options, listed via the help flag
- Can be added as a dev dependency for build pipelines
- Uses payload-openapi for generation and configuration
Use cases
- Produce an OpenAPI specification for a Payload API during a build pipeline
- Document a Payload REST API for consumers without writing a spec by hand
From the author
Create openapi docs for your payload cms
Installation
npm i create-payload-api-docs142
Stars
15
Forks
13
Open Issues
2 years ago
Last Updated
0
Weekly Downloads
v1.4.0
npm Version
13.6 KB
Unpacked Size
7
Dependencies
Trends (last 90 days)
Trends appear after 7 days of data. Daily snapshots have not started yet.
Shared by 5 plugins in teunmooij/payload-tools.
Trends appear after 7 days of data. Daily snapshots have not started yet.
Each point is npm's rolling 7-day download count.
Health Score
Composite score based on GitHub activity, stars, npm downloads, publish recency, dependency count, and package size.
Badge for your README
[](https://payloaddirectory.dev/plugins/611765581-create-api-docs)<a href="https://payloaddirectory.dev/plugins/611765581-create-api-docs"><img src="https://payloaddirectory.dev/badge/611765581-create-api-docs.svg" alt="Payload Directory"></a>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
Similar plugins
query
Type-safe query builder and field selection utility for Payload REST and internal APIs
380/wk142v1
swagger
Generate OpenAPI 3 docs and a Swagger UI from your Payload config
380/wk142v1
openapi
Generate OpenAPI 3 documents from your Payload config, including collections, globals and custom endpoints
360/wk142v1
payload plugin openapi
Generate OpenAPI 3.0, 3.1 or 3.2 specs from your Payload config and serve them with Scalar or Swagger UI
80437/wk18v4
payload oapi
Generate an OpenAPI 3.0 or 3.1 spec from your Payload config with optional documentation UIs
670/wk125v3
payload operations
Typed custom operations for Payload CMS used with the native Payload REST SDK
570/wk2v3