OpenAPI

Описание

Плагин OpenAPI для Payload CMS создает полную документацию по OpenAPI для ваших API-эндпоинтов, определенных в приложении Payload CMS. Он поддерживает работы с эндпоинтами коллекций, глобальными и пользовательскими эндпоинтами, а также требования к аутентификации. Сгенерированная документация полностью типизирована, что обеспечивает точное представление запросов, ответов и параметров. Для интеграции используйте функцию `createDocument`, передавая конфигурацию вашего Payload и дополнительные параметры для настройки вывода. Документация может включать дополнительные детали OpenAPI из внешних источников, таких как `package.json` и опциональные файлы `.openapi` для объединения пользовательских схем. Плагин позволяет широкую настройку для исключения определенных путей или пропуска анализа доступа для выбранных коллекций. Этот плагин полезен разработчикам, стремящимся точно документировать свои API, облегчать понимание доступных эндпоинтов и упрощать сотрудничество и интеграцию с другими сервисами.

О пакете

Имя пакета

payload-openapi

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

1.4.0

Размер

109 кБ

Лицензия

MIT

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

359

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

15 июл. 2023 г.