agent API guide

Создаёт актуальную документацию и справочник API для Payload CMS.

Сообщество 2 14/нед MIT v1.0.1

Установка

pnpm add @matija2209/payload-agent-api-guide

Описание

Плагин генерирует актуальную документацию и справочник API, специально предназначенные для проектов на Payload CMS. Он считывает конфигурацию вашего проекта и создает различные выходные форматы, включая интерактивный браузер API, спецификацию OpenAPI и краткое руководство для разработчиков и AI-агентов. Сгенерированная документация помогает избежать недоразумений при работе с вызовами REST API Payload, предоставляя примеры и инструкции, адаптированные под конкретный проект. Ключевые выходные форматы включают удобочитаемое HTML-руководство, файл спецификации OpenAPI 3.1 и структурированные карты для AI-агентов. Плагин фиксирует детали каждой коллекции, такие как имена и типы полей, связи и требования к аутентификации, что позволяет эффективно формировать запросы. Эта функциональность полезна для разработчиков, которым нужна детализированная информация о проекте API, а также для AI-агентов, которым требуются ясные шаблоны запросов.

О пакете

Имя пакета
@matija2209/payload-agent-api-guide
Последняя версия
1.0.1
Размер
121 кБ
Лицензия
MIT
Загрузок в неделю
14
Последняя публикация
4 июн. 2026 г.

Ещё от matija2209

Профиль автора