payload-oapi
v0.1.0
Published
An OpenAPI plugin for Payload CMS
Downloads
520
Maintainers
Readme
Payload OpenAPI Plugin
Autogenerate an OpenAPI specification from your Payload CMS instance and use it for documentation or to generate client SDKs.
Roadmap
- [x] Complete description of collection CRUD endpoints
- [x] Complete description of globals CRUD endpoints
- [x] Integrated Swagger UI and Rapidoc
- [ ] Custom endpoints
- [ ] Authentication endpoints and specification
- [ ] Preferences endpoints
Installation
Install the plugin from npm - yarn add payload-oapi
or npm i payload-oapi
.
Setup
To add the OpenAPI specification endpoint to your Payload app, simply import the openapi
plugin and add it to your payload configuration:
import { openapi } from 'payload-oapi'
buildConfig({
plugins: [
openapi({ openapiVersion: '3.0', metadata: { title: 'Dev API', version: '0.0.1' } }),
// ...
],
// ...
})
To add a documentation UI, use the swaggerUI
, rapidoc
or redoc
plugins, respectively:
import { openapi, swaggerUI } from 'payload-oapi'
buildConfig({
plugins: [
openapi(/* ... */),
swaggerUI({/* ... */})
],
// ...
})