Swagger

Описание

Плагин payload-swagger создает документацию OpenAPI 3 на основе вашей конфигурации Payload. Он добавляет маршруты для предоставления документа OpenAPI и интерфейса Swagger UI, что упрощает исследование API-эндпоинтов. Плагин использует пакет payload-openapi для документирования всех доступных эндпоинтов, включая коллекции, глобальные, пользовательские и аутентификационные. При этом формируются полностью типизированные схемы для запросов и ответов. Пользователи могут расширять сгенерированный документ OpenAPI с помощью информации из файла package.json или опционально из конфигурационного файла .openapi. Плагин предлагает гибкие параметры настройки для пользовательских маршрутов Swagger UI, анализа уровня доступа к коллекциям и определения пользовательских эндпоинтов. Также можно исключать определенные части конфигурации из документации. Примеры пользовательских эндпоинтов можно включать прямо в конфигурацию Payload, а документацию для пользовательских маршрутов можно добавлять отдельно. Такое интегрированное решение позволяет удобно документировать сложные API Payload наряду с основными функциями CMS.

О пакете

Имя пакета

payload-swagger

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

1.4.0

Размер

24 кБ

Лицензия

MIT

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

292

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

15 июл. 2023 г.