An OpenAPI plugin for Payload CMS
npm install payload-oapi-pafnutypnpm add payload-oapi
npm install payload-oapi
yarn add payload-oapi
openapi plugin and add it to your payload configuration:
typescript
import { openapi } from 'payload-oapi'
buildConfig({
plugins: [
openapi({ openapiVersion: '3.0', metadata: { title: 'Dev API', version: '0.0.1' } }),
],
// ...
})
`
2. Add a documentation UI plugin (optional)
To provide a user interface for your API documentation, you can add one of the following plugins:
- scalar
- swaggerUI
- rapidoc
- redoc
Example usage:
`typescript
import { openapi, scalar, swaggerUI, rapidoc, redoc } from 'payload-oapi'
// Choose one documentation UI plugins as needed
buildConfig({
plugins: [
openapi(/ ... /),
// Uncomment the UI you want to use:
scalar({ / ...options / }),
// swaggerUI({ / ...options / }),
// rapidoc({ / ...options / }),
// redoc({ / ...options / }),
],
// ...
})
``