api-designer
RESTful 및 GraphQL API 설계 및 문서화
이 스킬은 현대적 API를 설계, 문서화, 구현하기 위한 종합적인 가이드를 제공합니다. 업계 모범 사례, 인증 패턴, 프로덕션 준비된 API 설계를 위한 버저닝 전략과 함께 REST와 GraphQL 패러다임을 모두 다룹니다.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "api-designer". Design authentication endpoints for a REST API with OAuth 2.0
Résultat attendu:
- POST /auth/register - 이메일과 비밀번호로 새 사용자 계정 생성
- POST /auth/login - 인증하고 리프레시 토큰과 함께 액세스 토큰 수신
- POST /auth/logout - 리프레시 토큰 무효화 및 세션 종료
- POST /auth/refresh - 유효한 리프레시 토큰을 새 액세스 토큰으로 교환
- GET /auth/me - 현재 인증된 사용자 프로필 반환
- Use JWT bearer tokens with RS256 signing algorithm
Utilisation de "api-designer". Create pagination pattern for large API collections
Résultat attendu:
- 대규모 데이터셋에는 커서 기반 페이지네이션 권장
- 응답에 nextCursor와 hasMore 필드 포함
- 작고 예측 가능한 결과 집합에는 오프셋 기반 페이지네이션
- 가능한 경우 항상 전체 개수 포함
- 기본 제한 20, 페이지당 최대 100개 항목
Utilisation de "api-designer". Design error response format for REST API
Résultat attendu:
- 오류 코드, 메시지, 상세 필드 수준 오류 포함
- 문제 해결 및 상관관계를 위해 요청 ID 추가
- ISO 8601 UTC 형식의 타임스탬프 포함
- 적절한 HTTP 상태 코드 사용: 400, 401, 403, 404, 422, 429, 500
- 오류 응답에 민감한 데이터나 스택 트레이스 절대 노출하지 않기
Audit de sécurité
SûrAll 661 static findings are FALSE POSITIVES. The skill is a documentation/reference guide for API design containing markdown guides, OpenAPI examples, and a local Python utility. No network operations, no credential access, no command execution. The static analyzer incorrectly flagged cryptographic algorithm names (RS256, HS256) in documentation as 'weak crypto', backticks in markdown as 'shell execution', and REST endpoint paths as 'system reconnaissance'.
Facteurs de risque
⚡ Contient des scripts (1)
📁 Accès au système de fichiers (2)
Score de qualité
Ce que vous pouvez construire
API 사양 작성
REST 또는 GraphQL API를 종합적인 OpenAPI 문서와 인증 패턴으로 설계합니다.
기존 API 문서화
기존 API에서 OpenAPI 사양을 생성하고 대화형 문서를 만듭니다.
API 문서 작성
코드 예제와 오류 가이드를 포함한 명확한 API 문서 작성 모범 사례를 학습합니다.
Essayez ces prompts
등록, 로그인, 프로필 관리, 비밀번호 재설정을 위한 엔드포인트가 있는 사용자 관리용 REST API를 설계하세요. 적절한 HTTP 메서드, 상태 코드, 오류 응답 형식을 포함하세요.
게시물, 댓글, 태그를 포함하는 블로그 API를 위한 OpenAPI 3.0 사양을 생성하세요. JWT 인증과 컬렉션 페이지네이션을 포함하세요.
상품, 카테고리, 장바구니, 주문을 포함하는 전자상거래 애플리케이션을 위한 GraphQL 스키마를 설계하세요. 적절한 입력 타입과 페이지네이션을 포함하세요.
기존 v1 API에 깨지는 변경을 도입하기 위한 API 버저닝 전략을 계획하세요. URL 버저닝(예: /v2/users) 또는 헤더 버저닝(예: Accept: application/vnd.api.v2+json)을 사용해야 하나요? 사용 중단 공지, 마이그레이션 경로, 하위 호환성 고려사항을 포함하세요.
Bonnes pratiques
- 모든 엔드포인트에서 일관된 이름 규칙, URL 구조, 오류 응답 형식을 사용
- API 리소스를 보호하기 위해 적절한 인증과 레이트 리미팅 구현
- 예제와 오류 코드를 포함한 OpenAPI 사양으로 모든 엔드포인트 문서화
Éviter
- URL에서 동사 사용을 피하세요 - REST API는 리소스에 대해 명사를 사용해야 합니다
- 오류 응답에 구현 세부 사항이나 민감한 데이터를 노출하지 마세요
- URL 중첩을 2단계 이상 깊게 하는 것을 피하세요 - 대신 쿼리 파라미터를 사용하세요