OpenAPI
Создает спецификации OpenAPI 3.0/3.1/3.2 из конфигураций Payload CMS.
Установка
pnpm add @seshuk/payload-plugin-openapi Описание
Этот плагин генерирует спецификации OpenAPI версии 3.0, 3.1 и 3.2 прямо из настроек Payload CMS. Пользователи могут документировать коллекции, глобальные переменные, аутентификацию, версии и задачи без необходимости в аннотациях. Плагин поддерживает контроль над тем, какие сущности и операции будут доступны, а также позволяет уточнять схемы полей с помощью метаданных `custom.openapi`. С встроенной локализацией для описаний и поддержкой UI, обеспечивается интерактивная документация с использованием Scalar или Swagger UI. Плагин предлагает гибкость в предоставлении спецификации OpenAPI и может генерировать файлы документации для интеграции CI и генерации клиентского кода. Для работы требуется версия Payload 3.53.0 и Node.js версии 20 или выше. Основные настройки включают название API, версию и возможность фильтровать, какие сущности будут отображаться в сгенерированной документации.
О пакете
- Имя пакета
@seshuk/payload-plugin-openapi- Последняя версия
0.2.3- Размер
- 469 кБ
- Лицензия
- MIT
- Загрузок в неделю
- 1,6 тыс.
- Последняя публикация
- 8 окт. 2026 г.
Ещё от maximseshuk
Профиль автораJanitor
Находит осиротевшие файлы и документы без ссылок в Payload и удаляет только те записи, которые вы одобрили.
Sitemap
Строит sitemap.xml из коллекций Payload и статических страниц и хранит файлы в любом storage adapter.
Shared plugin tooling
Dev-зависимость с общими конфигами lint, форматирования, TypeScript, сборки, тестовой БД и релиза для плагинов Payload.
Bunny Storage Adapter
Адаптер хранилища Bunny.net для Payload CMS 3.x с дозагрузкой TUS, интеграцией Bunny Stream и очисткой кэша CDN.
Media Preview
Предварительный просмотр изображений, видео, аудио и документов в админ-панели Payload CMS.
Похожие плагины
Ещё в категории «Инструменты разработки»Puck visual page builder
Интеграция визуального конструктора Puck с Payload CMS для редактирования с помощью перетаскивания.
Create Ideal CMS
Интерактивный CLI для развёртывания монорепозитория Payload CMS с предустановленными плагинами @focus-reactive.
OpenAPI
Генерирует спецификацию OpenAPI из конфигурации Payload CMS 3.x и подключает интерфейс документации на выбор: Swagger UI, Redoc, RapiDoc или Scalar.
Markdown documentation sync
Синхронизирует Markdown-документацию с Payload CMS с помощью Git.
Dry Run
Плагин для Payload CMS: проверяет операцию create с полным циклом валидации, хуков и доступа, затем откатывает транзакцию.