{"id":16992310,"url":"https://github.com/janbuchar/payload-oapi","last_synced_at":"2025-03-22T15:30:59.852Z","repository":{"id":147627533,"uuid":"618796772","full_name":"janbuchar/payload-oapi","owner":"janbuchar","description":"A Payload CMS plugin for OpenAPI (3.0, 3.1) specification generation","archived":false,"fork":false,"pushed_at":"2025-03-11T07:47:50.000Z","size":589,"stargazers_count":30,"open_issues_count":5,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T13:16:15.622Z","etag":null,"topics":["api-documentation","openapi","openapi3","openapi31","payload-plugin","payloadcms"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/janbuchar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-25T11:34:02.000Z","updated_at":"2025-03-11T21:58:01.000Z","dependencies_parsed_at":"2024-05-16T22:25:09.456Z","dependency_job_id":"51902054-b4d5-4ef5-818d-9dca5de4babe","html_url":"https://github.com/janbuchar/payload-oapi","commit_stats":null,"previous_names":["janbuchar/payload-oapi","teyras/payload-oapi"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janbuchar%2Fpayload-oapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janbuchar%2Fpayload-oapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janbuchar%2Fpayload-oapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janbuchar%2Fpayload-oapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/janbuchar","download_url":"https://codeload.github.com/janbuchar/payload-oapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244978514,"owners_count":20541866,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","openapi","openapi3","openapi31","payload-plugin","payloadcms"],"created_at":"2024-10-14T03:28:52.112Z","updated_at":"2025-03-22T15:30:59.377Z","avatar_url":"https://github.com/janbuchar.png","language":"TypeScript","readme":"# Payload OpenAPI Plugin\n\n[![npm version](https://badge.fury.io/js/payload-oapi.svg)](https://www.npmjs.com/package/payload-oapi)\n\nAutogenerate an OpenAPI specification from your Payload CMS instance and use it for documentation or to generate client SDKs.\n\n# Roadmap\n\n- [x] Complete description of collection CRUD endpoints\n- [x] Complete description of globals CRUD endpoints\n- [x] Integrated Swagger UI and Rapidoc\n- [ ] Custom endpoints\n- [ ] Authentication endpoints and specification\n- [ ] Preferences endpoints\n\n# Installation\n\nInstall the plugin from npm - `yarn add payload-oapi` or `npm i payload-oapi`.\n\n# Setup\n\nTo add the OpenAPI specification endpoint to your Payload app, simply import the `openapi` plugin and add it to your payload configuration:\n\n```typescript\nimport { openapi } from 'payload-oapi'\n\nbuildConfig({\n  plugins: [\n    openapi({ openapiVersion: '3.0', metadata: { title: 'Dev API', version: '0.0.1' } }),\n    // ...\n  ],\n  // ...\n})\n```\n\nTo add a documentation UI, use the `swaggerUI`, `rapidoc` or `redoc` plugins, respectively:\n\n```typescript\nimport { openapi, swaggerUI } from 'payload-oapi'\n\nbuildConfig({\n  plugins: [\n    openapi(/* ... */),\n    swaggerUI({/* ... */})\n  ],\n  // ...\n})\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanbuchar%2Fpayload-oapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjanbuchar%2Fpayload-oapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanbuchar%2Fpayload-oapi/lists"}