AIKraft/Skills/api-patterns

api-patterns

Описывает принципы проектирования API и помогает выбирать между REST, GraphQL и tRPC. Включает рекомендации по форматам ответов, версионированию и пагинации.

sickn33 official Разработка ★ 47.3k

Что делает навык

Навык описывает принципы проектирования API, помогая выбирать между REST, GraphQL и tRPC в зависимости от потребителей и ограничений развертывания. Он включает рекомендации по форматам ответов, версионированию, пагинации, аутентификации и защите от перегрузок.

Когда применять

  • Определение нового контракта эндпоинта для известных потребителей.
  • Выбор стиля API (REST, GraphQL или tRPC) под конкретный контекст проекта.
  • Изменение поведения пагинации, обработки ошибок или аутентификации.
  • Планирование стратегии эволюции API и версионирования.

Как работает

  1. Записать информацию о потребителях, развернутых версиях, ожидаемом размере полезной нагрузки, правилах доступа и обязательствах по совместимости.
  2. Прочитать соответствующие файлы из карты контента (например, api-style.md, response.md) в зависимости от задачи.
  3. Сравнить реалистичные варианты выбора стиля API и формата ответов.
  4. Определить стратегию версионирования, аутентификации и ограничения частоты запросов (rate limiting).
  5. Сформировать примеры запросов и ответов, а также случаи отклонения.
  6. Документировать подход к разработке API.

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

Как выбрать между REST, GraphQL и tRPC для нового микросервиса?
Разработай структуру ответа и стратегию пагинации для публичного API заказов.
Какие стратегии версионирования API ты рекомендуешь для бэкенда с множеством клиентов?

Что понадобится

  • Python 3 (для запуска скрипта api_validator.py)

Описание составлено по SKILL.md навыка, сверено 08.10.2026.

Как подключить

1Скачать навык
# возьмите папку навыка «api-patterns» из репозитория: # https://github.com/sickn33/agentic-awesome-skills
2Положить папку с SKILL.md к навыкам ассистента
# положите папку навыка туда, где ассистент ищет skills: cp -r api-patterns/ ~/.claude/skills/api-patterns/

Навык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.