api-design
Проектирование REST API с лучшими практиками
또한 다음에서 사용할 수 있습니다: supercent-io
API часто страдают от несогласованного именования, неправильной структуры URL и неправильного использования HTTP-методов. Этот навык предоставляет четкие рекомендации для проектирования интуитивно понятных, масштабируемых и простых в обслуживании API.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"api-design" 사용 중입니다. Design a REST endpoint to create and retrieve orders
예상 결과:
- POST /orders - Создать новый заказ (возвращает 201 Created с заголовком Location)
- GET /orders?status=pending&sort=-createdAt - Список заказов с фильтрацией и сортировкой
- GET /orders/{id} - Получить конкретный заказ (возвращает 404 если не найден)
- Все ответы используют формат обертки с полями 'data' и 'meta'
"api-design" 사용 중입니다. How should I structure error responses for validation failures?
예상 결과:
- Используйте 400 Bad Request с кодом ошибки VALIDATION_ERROR
- Включите массив details с сообщениями для конкретных полей
- Пример: { error: { code: 'VALIDATION_ERROR', message: 'Invalid input', details: [{ field: 'email', message: 'Must be valid email' }] } }
보안 감사
안전This is a documentation-only skill containing REST API design guidelines. All 99 static findings are false positives triggered by documentation examples being misinterpreted as executable code. No executable code, network calls, file system access, or external commands exist in this skill.
위험 요인
🌐 네트워크 접근 (1)
⚙️ 외부 명령어 (41)
🔑 환경 변수 (1)
품질 점수
만들 수 있는 것
Проектирование новых REST API
Применяйте лучшие практики при проектировании новых REST-endpoints для обеспечения согласованности и удобства использования.
Проверка существующих API
Проверяйте текущие дизайны API на соответствие отраслевым стандартам и выявляйте области для улучшения.
Создание руководств по стилю API
Устанавливайте командные соглашения для именования URL, форматов ответов и обработки ошибок.
이 프롬프트를 사용해 보세요
Спроектируйте REST эндпоинт для управления пользователями. Включите структуру URL, HTTP-метод, формат тела запроса, формат ответа и подходящие коды статуса.
Какой правильный способ структурировать ответы об ошибках в REST API? Покажите примеры для ошибок валидации, ошибок аутентификации и сценариев 'не найдено'.
Спроектируйте REST API для пагинированных коллекций. Покажите оба подхода к пагинации: на основе смещения и на основе курсора с примерами запросов и ответов.
Какие лучшие практики для версионирования API? Сравните версионирование через путь URL и версионирование через заголовки. Когда следует использовать каждый подход?
모범 사례
- Используйте множественное число для URL ресурсов (например, /users, а не /user)
- Применяйте HTTP-методы правильно: GET для чтения, POST для создания, PUT для замены, PATCH для частичного обновления, DELETE для удаления
- Структурируйте ответы последовательно с форматом обертки, включая метаданные для коллекций
피하기
- Избегайте глаголов в URL (например, /getUsers, /createOrder) - HTTP-метод передает действие
- Не используйте несогласованные соглашения об именовании, такие как смешивание snake_case и camelCase в одном API
- Избегайте глубокой вложенности более двух уровней - выравнивайте иерархии ресурсов, когда это возможно