Payload Market

Swagger

Swagger plugin for Payload CMS that generates OpenAPI documentation.

Community 142 1.7k/wk MIT v1.4.0

Installation

pnpm add payload-swagger

About

Payload-swagger generates OpenAPI 3 documentation from your Payload configuration. It adds routes for serving the OpenAPI document and the Swagger UI interface, enabling users to explore API endpoints easily. The plugin leverages the payload-openapi package to document all available endpoints, including collection, global, custom, and authentication endpoints, while providing fully typed schema definitions for requests and responses. Users can extend the generated OpenAPI document with information from the package.json file or optionally from a .openapi config file. The plugin provides flexible configuration options to customize the Swagger UI routes, access level analysis on collections, and define custom endpoints. Users can also exclude certain parts of the configuration from being documented. Examples for custom endpoints can be incorporated directly into the Payload configuration, and documentation for custom routes can be added as well. This integration allows seamless documentation of complex Payload APIs alongside the core features of the CMS.

Package info

Package name
payload-swagger
Latest version
1.4.0
Unpacked size
24 kB
License
MIT
Weekly downloads
1.7k
Last publish
Jul 15, 2023

More from teunmooij

View profile

create api docs

Generate OpenAPI 3 documentation for Payload CMS.

142 14/wk v1 Content

OpenAPI

Generate OpenAPI 3 documentation for Payload CMS endpoints.

142 1.7k/wk v1 Devtools

Query

Type-safe query filters and field selection for Payload, with a REST select parameter plugin.

142 17/wk v1 Devtools

RBAC

Adds role-based access control to your Payload CMS.

142 18/wk v1 Auth

Similar plugins

More in Devtools

OpenAPI

Autogenerate an OpenAPI specification from a Payload CMS instance and render it with Swagger UI, Redoc, RapiDoc, or Scalar.

124 14.7k/wk v3 Devtools

Puck visual page builder

Integrate Puck visual page builder with Payload CMS for drag-and-drop editing.

105 1.3k/wk v3 Content

Create Ideal CMS

Interactive CLI that scaffolds a production-ready Payload CMS monorepo preconfigured with FocusReactive plugins.

23 76/wk Devtools

Dry Run

Test Payload create operations end-to-end without persisting, by rolling back the transaction after hooks and validation run.

6/wk v3 Devtools

OpenAPI

Generates OpenAPI specifications from Payload CMS configurations.

14 705/wk v3 Devtools

Repository

Wrapper around Payload's Local API providing repository operations.

5/wk v3 Content