create api docs

Описание

Инструмент для командной строки, предназначенный для генерации документации OpenAPI 3 для Payload CMS. Пользователи могут запускать команду CLI для автоматического создания структурированной документации API. Этот инструмент использует пакет payload-openapi, который также можно использовать программно для генерации документации. Разработчики могут легко интегрировать этот инструмент в свои конвейеры сборки, добавив его в качестве зависимости для разработки, что позволяет поддерживать актуальность документации в соответствии с кодом. Плагин поддерживает различные параметры конфигурации, что обеспечивает гибкость в процессе генерации документации. Альтернативами являются использование payload-openapi для программной генерации документации или пакет payload-swagger для более удобной интеграции с Swagger.

О пакете

Имя пакета

create-payload-api-docs

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

1.4.0

Размер

14 кБ

Лицензия

MIT

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

17

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

15 июл. 2023 г.