Этот навык предоставляет комплексное руководство по проектированию RESTful и GraphQL API в соответствии с лучшими практиками отрасли. Он помогает разработчикам создавать хорошо структурированные, версионированные и задокументированные API.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"api-design" 사용 중입니다. Design a REST API for a blog with posts and comments
예상 결과:
Endpoints: GET/POST /api/v1/posts, GET/PUT/DELETE /api/v1/posts/{id}, GET/POST /api/v1/posts/{id}/comments, Response codes: 200, 201, 204, 400, 401, 403, 404
"api-design" 사용 중입니다. Create OpenAPI spec for user management
예상 결과:
OpenAPI 3.0 with /users endpoint, GET (list users with pagination), POST (create user), JWT Bearer auth, 200/201 responses with User schema
보안 감사
안전All 76 static findings are false positives. The skill is pure documentation providing API design guidance. The scanner detected backtick formatting in markdown examples, legitimate documentation URLs, and JWT authentication references - none of which constitute security risks.
감지된 패턴
품질 점수
만들 수 있는 것
Разработка нового API
Используйте при запуске нового проекта API для установления правильных соглашений, именования ресурсов и структуры endpoints с самого начала
Документация API
Генерируйте спецификации OpenAPI и документацию для существующих или новых API для предоставления командам фронтенда и внешним потребителям
Рефакторинг и аудит API
Проверяйте существующие дизайны API на соответствие лучшим практикам и выявляйте области для улучшения в именовании, версионировании и структуре
이 프롬프트를 사용해 보세요
Спроектируйте REST API для ресурса [resource name]. Включите определения endpoints, HTTP-методы, коды ответа и форматы запросов/ответов.
Спроектируйте REST API с следующими ресурсами: [list resources] и их связями. Включите вложенные ресурсы и правильную URL-структуру.
Сгенерируйте спецификацию OpenAPI 3.0 для API с следующими endpoints: [list endpoints]. Включите схемы запросов/ответов, параметры и аутентификацию.
Спроектируйте GraphQL схему для [use case]. Включите определения типов, запросы, мутации и соответствующие резолверы.
모범 사례
- Используйте последовательное именование ресурсов с существительными, а не глаголами, и формами множественного числа
- Версионируйте API с самого начала, используя версионирование через URL-путь (например, /api/v1/)
- Реализуйте правильную обработку ошибок с последовательным форматом ответа об ошибках, включая коды ошибок и детали
피하기
- Использование глаголов в названиях endpoints (например, /getUsers вместо /users)
- Отсутствие версионирования API, что ломает клиентов при необходимости изменений
- Возвращение разных форматов endpoints ошибок между