{"repo":"janbuchar/payload-oapi","free":true,"listed":false,"github":"https://github.com/janbuchar/payload-oapi","clone":"git clone https://github.com/janbuchar/payload-oapi.git","description":"A Payload CMS plugin for OpenAPI (3.0, 3.1) specification generation","language":"TypeScript","stars":122,"topics":["payload-plugin","api-documentation","openapi","openapi3","openapi31","payloadcms"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"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 - [x] Authentication endpoints and specification - [x] Preferences endpoints - [x] Support Payload CMS 3.x - [x] Support generating both OpenAPI 3.0 and 3.1 - [x] Collection and global filtering - [ ] Custom endpoints Installation You can install the plugin using your preferred package manager: - pnpm add payload-oapi - npm install payload-oapi - yarn add payload-oapi Setup 1. Add the OpenAPI core plugin To add the OpenAPI specification endpoint to your Payload app, simply import the openapi plugin and add it to your payload configuration: 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: 3. Filter collections and globals (optional) Control which collections and globals appear in the OpenAPI spec using the filters option: - includeCollections / excludeCollections — filter collections by slug - includeGlobals / excludeGlobals — filter globals by slug - hideInternalCollections — exclude payload- collections Example: Usage Unless you configured it otherwise, your spec will be accessible via . If you added a documentation UI, that will ","default_branch":null,"files":null,"tree":[],"storefront":"/r/janbuchar","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/janbuchar/payload-oapi/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}