iiuniversitet.ruЦентр обучения нейросетямОткрыть каталог

Документация API

Генерирует документацию API с примерами запросов.

СкиллРазработано в iiuniversitetCodexНаш материалНужен терминалПроверка не требуется
Скачать архив
Что делает
Генерирует документацию API с примерами запросов.
Когда брать
Когда вы просите: «задокументируй API» или «документация api».
Пример запроса
$api-docs задокументируй API

Как включить

  1. Скачайте архив и распакуйте его.
  2. Положите папку api-docs в ~/.agents/skills/.
  3. Вызовите скилл командой $api-docs или найдите его через /skills.

Текст

---
name: api-docs
description: "Генерирует документацию API с примерами запросов. Используй, когда пользователь просит: «задокументируй API» или «документация api». Не используй для задач вне этой темы."
---

Документация API

Генерирует документацию API с примерами запросов.

Перед началом

Прочитай AGENTS.md и README, определи стек, команды сборки и тестов. Работай в текущей ветке, не трогай несвязанные файлы.

Порядок работы

  1. Собрать эндпоинты.
  2. Описать параметры и ответы.
  3. Добавить примеры curl.
  4. Опубликовать.
  5. Проверь результат по правилам ниже и кратко опиши, что сделано.

Формат результата

Документация Markdown/HTML.

Правила

  • Пиши для человека, который видит проект впервые.
  • Проверяй, что команды из документации реально работают.
  • Не переписывай общую историю Git без подтверждения.

Пример вызова

$api-docs задокументируй API

Разработано в iiuniversitet — https://iiuniversitet.ru/?utm_source=bonus&utm_medium=skill&utm_campaign=katalog&utm_content=api-docs

Автор: iiuniversitet. Каталог скиллов iiuniversitet.

Похожие