OpenAPI

Описание

Плагин обходит конфигурацию Payload и собирает спецификацию OpenAPI, covering collection CRUD, global CRUD, auth-операции, preferences и кастомные эндпоинты. Поддерживается вывод в формате OpenAPI 3.0 и 3.1, при необходимости 3.1 конвертируется в 3.0. Спецификация доступна по настраиваемому пути, по умолчанию /api/openapi.json. Auth-коллекции документируются с учётом их auth-конфигурации. Флаг `disableLocalStrategy` убирает операции с паролем, `loginWithUsername` меняет структуру тела запроса login, `maxLoginAttempts: 0` удаляет `/unlock`, а включение `verify` добавляет `/verify/{id}`. Кастомные эндпоинты, объявленные через `endpoints` на коллекции, глобале или в корне конфига, попадают в спецификацию при наличии OpenAPI-операции в поле `custom.openapi`. Поля `tags`, `operationId`, `summary` и `security`, не указанные явно, генерируются автоматически. Состав спецификации настраивается через фильтры: `includeCollections`, `excludeCollections`, `includeGlobals`, `excludeGlobals` и `hideInternalCollections`. Для схем за reverse proxy предусмотрен параметр `apiBasePath`, переопределяющий префикс путей операций. Просмотр спецификации реализован отдельными UI-плагинами для Scalar, Swagger UI, RapiDoc и Redoc. Достаточно подключить любой из них рядом с основным плагином `openapi`, и документация откроется по адресу /api/docs. Пакет написан на TypeScript и работает с Payload CMS 3.x как peer dependency.

О пакете

Имя пакета

payload-oapi

Последняя версия

0.3.1

Размер

189 кБ

Лицензия

MIT

Загрузок в неделю

14,7 тыс.

Последняя публикация

3 окт. 2026 г.