api-and-interface-design
Практические рекомендации по проектированию стабильных, документированных API и публичных интерфейсов.
Суть
Что это за skill и зачем он нужен
Навык содержит набор принципов и шаблонов для создания устойчивых API и интерфейсов: от закона Хайрума и правила «одна версия» до подхода «contract‑first», единой схемы ошибок, валидации на границах системы и предпочтения добавления новых полей вместо их изменения. Включены примеры REST‑эндпоинтов, пагинации, фильтрации, патч‑обновлений и типовых TypeScript‑интерфейсов (дискриминированные объединения, разделение входных/выходных моделей, брендинг ID). Также описаны типичные оправдания и «красные флажки», которые следует избегать.
Установка
Как установить
npx skills add https://github.com/addyosmani/agent-skills --skill api-and-interface-designСценарии
Когда использовать
Подходит
- Разработка новых REST‑ или GraphQL‑эндпоинтов
- Определение границ модулей и контрактов между командами
- Создание типизированных пропсов для UI‑компонентов
- Проектирование схемы БД, влияющей на форму API
- Модернизация существующих публичных интерфейсов
Не подходит
- Для одноразовых скриптов без публичного доступа
- Когда требуется быстрый прототип без обязательств по совместимости
- Для внутренних функций, которые никогда не будут использоваться извне
Доверие
Проверки безопасности
Проверка вернула предупреждение. Перед установкой стоит просмотреть исходники, команды и доступы.
Проверка не нашла критичных проблем.
Низкий риск · проблем не найдено.
Предупреждений нет.
Оценка 93/100 · проанализировано 2 раздела.
Похожие