К основному содержанию
скилл CX Codex

w-api-docs — скилл для Claude Code: обновление API-документации

Скилл w-api-docs для Claude Code обновляет API-документацию из исходной схемы или маршрутов. Он подключается к задаче, когда нужно изменить API и пересобрать его документацию.

MIT 647 установок ★ 1 обновлён 2026-10-02

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add blockmatic-icebox/basilic-skills --skill w-api-docs -a claude-code
Открыть на GitHub

Что делает w-api-docs

w-api-docs обновляет API-документацию через исходную схему или маршруты, а не правит сгенерированные файлы вручную. Сначала скилл предлагает прочитать MDX-документацию и README генератора, найти источник схемы и скрипт генерации в package.json.

Изменения вносятся в схему или маршрут, затем запускается описанная в проекте команда генерации. Если в репозитории есть скрипты проверки расхождений, их тоже нужно запустить. Сгенерированные OpenAPI-файлы, клиенты и SQL напрямую не редактируются.

MDX-файлы для потребителей API обновляются только при изменении поведения. Скилл не должен придумывать правила авторизации, ограничения частоты запросов или версионирования. Если изменились поведение или команды, документацию можно обновить через /w-docs.

Какие задачи решает

  • обновить API-документацию после изменения схемы или маршрута
  • пересобрать OpenAPI из исходного источника
  • проверить расхождения между схемой и сгенерированными файлами
  • синхронизировать MDX для потребителей API с новым поведением

Примеры запросов агенту

  • Обнови документацию API после изменения маршрута Fastify и запусти генератор из package.json.
  • Измени схему TypeBox и пересобери OpenAPI, не редактируя сгенерированные файлы.
  • Синхронизируй MDX для потребителей API с изменившимся поведением.

Как установить w-api-docs

1Через Skills CLI (Vercel)

npx skills add blockmatic-icebox/basilic-skills --skill w-api-docs -a claude-code

2Вручную: положить файлы

~/.claude/skills/w-api-docs/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/w-api-docs/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о w-api-docs

Как установить w-api-docs в Claude Code?

Выполни npx skills add blockmatic-icebox/basilic-skills --skill w-api-docs -a claude-code, затем установи скилл по пути ~/.claude/skills/w-api-docs/SKILL.md.

Что делает w-api-docs?

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

Какие файлы меняет w-api-docs?

Изменения вносятся в исходную схему или маршрут. MDX для потребителей API обновляется только при изменении поведения; сгенерированные файлы напрямую не редактируются.

Исходный текст

SKILL.md · MIT
---
name: w-api-docs
description: Refresh API docs from the owning schema source; never edit generated OpenAPI by hand.
disable-model-invocation: true
---

Update API documentation from the source of truth (TypeBox/Fastify routes, or the repo's documented generator). Never edit generated OpenAPI, generated clients, or generated SQL directly.

1. Read the API docs MDX and the generator README. Identify the owning source and the generate script in package.json.
2. Change the owning schema or route, not the generated artifact.
3. Run the documented generate command. Check drift scripts if the repo has them.
4. Update adopter MDX only for behavior that changed. Do not invent auth, rate-limit, or versioning policy.
5. Docs: `/w-docs` if behavior or commands changed.

© blockmatic-icebox · MIT · blockmatic-icebox/basilic-skills

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
api-docs ruvnet Скилл api-docs собирает документацию по исходникам на TypeScript и JavaScript: находит публичные экспорты, разбирает JSDoc, дописывает недостающие комментарии и выдаёт OpenAPI 3.0 для HTTP-эндпоинтов. CX Codex +1 893установок fastify-typescript Mindrally Скилл fastify-typescript для Claude Code, Codex, Cursor и других платформ с правилами создания API на Fastify и TypeScript. Включается, когда нужна валидация через JSON Schema, интеграция с Prisma или тесты на Jest. CX Codex +1 904установок Branch Docs branch-docs MCP-сервер Branch Docs для поиска и чтения документации API Branch прямо в агенте. Достаёт эндпоинты, схемы, переменные серверов и страницы гайдов. CX Codex +1 1 760установок Octri API Docs OctriDev MCP-сервер Octri API Docs подключает документацию вашего API к ассистенту: поиск по эндпоинтам, готовые SDK-сниппеты и вызовы реальных запросов. CX Codex +1 ★ 4звёзд репо api-recon-and-docs yaklang Скилл api-recon-and-docs помогает исследовать структуру REST, mobile и GraphQL API перед тестированием. Он ищет скрытые эндпоинты, схемы и старые версии интерфейсов. CX Codex +1 4 200установок api-reference-documentation aj-geddes Скилл api-reference-documentation помогает агенту собрать справочник по API: эндпоинты, аутентификация, примеры запросов и ответов, спецификация OpenAPI. CX Codex +1 501установок

Из того же набора45

Весь набор →
w-shadcn Скилл w-shadcn для Claude Code устанавливает или дополняет примитивы shadcn в общем UI-пакете. Запускается для добавления компонента; изменение целого экрана передаётся команде /w-ui. CX Codex +1 647установок w-ui Скилл w-ui для Claude Code, который помогает создавать и менять пользовательские интерфейсы с учётом токенов проекта и доступности. Проверяет готовый экран в браузере на компьютере и мобильном устройстве. CX Codex +1 647установок w-diagram Скилл w-diagram для Claude Code строит диаграммы Mermaid по коду, архитектуре или потокам данных. Для продуктовой и архитектурной документации он сверяет MDX- и DESIGN.md-файлы с кодом. CX Codex +1 647установок w-onboard Скилл w-onboard для Claude Code проводит нового разработчика от клонирования репозитория до запущенного локального приложения. Он запускает настройку проекта и проверяет связь приложения с API. CX Codex +1 647установок w-docs Скилл w-docs для Claude Code обновляет документацию проекта после изменения кода или функции. Он выбирает слой документации по типу изменения. CX Codex +1 647установок w-architecture Скилл w-architecture для Claude Code помогает спланировать структуру реализации. Он сверяет изменения с архитектурными документами и ADR проекта. CX Codex +1 647установок w-roadmap Скилл w-roadmap для Claude Code сопоставляет код с GitHub issues и связанными документами. Запускается по явному запросу и показывает, что уже сделано, частично готово или отсутствует. CX Codex +1 647установок w-clarify Скилл w-clarify для Claude Code ищет пробелы в требованиях, которые мешают правильно выполнить задачу. Перед вопросами он сверяет запрос с кодом и документацией проекта. CX Codex +1 647установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой