Инструменты документации API для Payload CMS 2

Генераторы OpenAPI 3 для REST API Payload CMS, а ещё хелперы JSON-LD для страниц сайта и аудит, который находит данные, доступные без входа.

Инструмент командной строки, который записывает документ OpenAPI 3

Генерирует документы OpenAPI 3.0 для REST-эндпоинтов проекта Payload

Об этих пакетах

Инструменты документации генерируют документ OpenAPI 3 по REST-эндпоинтам Payload. Его читают Swagger UI, Redoc и генераторы клиентов. В категории есть ещё хелперы Schema.org JSON-LD и аудит данных, которые доступны без входа.

Что входит в категорию

  • OpenAPI, генератор документа OpenAPI 3.0 по REST-эндпоинтам
  • Create API Docs, генератор OpenAPI 3, который есть и среди CLI
  • Спецификации для Swagger UI, Redoc и генераторов клиентов
  • Хелперы SEO JSON-LD для страниц товаров, хлебных крошек и списков
  • Security, аудит данных, которые видны без входа на сайт

Как выбрать инструменты документации API

OpenAPI и Create API Docs работают как отдельные генераторы. Сверьте поддерживаемую версию Payload на их карточках и проверьте их на своём проекте, прежде чем на них полагаться. OpenAPI-плагины среди плагинов для разработчиков, наоборот, собирают спецификацию внутри приложения и умеют показывать её в Swagger UI или Scalar. Какой бы вариант вы ни выбрали, перегенерируйте спецификацию при изменении коллекций, чтобы она не расходилась с API. Запустите Security на стейджинге, и он покажет, какие данные может прочитать кто угодно без входа.

Частые вопросы

Генерирует ли Payload CMS документацию OpenAPI сам?

Нет. Payload генерирует типы TypeScript и схему GraphQL, но спецификацию OpenAPI для REST API не создаёт. Возьмите генератор из этой категории или OpenAPI-плагин из плагинов для разработчиков.

Работают ли эти генераторы OpenAPI с моей версией Payload?

Сначала сверьте поддерживаемую версию Payload на их карточках, потому что оба пакета старые и работают отдельно от приложения. OpenAPI-плагины среди плагинов для разработчиков читают конфиг прямо внутри приложения, поэтому следуют вашей настройке Payload.

Можно ли сгенерировать API-клиент по спецификации?

Да. Её прочитает любой генератор клиентов OpenAPI. Для проектов на TypeScript официальный Payload SDK часто проще, потому что REST API Payload в нём уже описан.