api-design-principles
REST 및 GraphQL API를 자신 있게 설계하세요
API 설계 결정은 종종 일관성 없이 유지하기 어려워집니다. 이 스킬은 선택을 안내하기 위한 명확한 패턴, 템플릿 및 체크리스트를 제공합니다.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"api-design-principles" 사용 중입니다. 내 사용자 및 주문 엔드포인트를 REST 모범 사례에 대해 검토해주세요.
예상 결과:
- 복수 명사를 사용하세요: /api/users 및 /api/orders
- /api/createUser 같은 액션 경로를 POST /api/users로 대체하세요
- page 및 page_size로 목록 엔드포인트에 페이지네이션을 추가하세요
- 성공적인 POST에는 201 Created를, DELETE에는 204를 반환하세요
"api-design-principles" 사용 중입니다. 사용자, 게시물, 댓글이 있는 블로그에 대한 GraphQL 스키마를 어떻게 구조화해야 하나요?
예상 결과:
- 적절한 관계로 User, Post, Comment 타입을 정의하세요
- 컬렉션에 대해 Relay 스타일 커서 페이지네이션을 사용하세요
- 오류 페이로드가 포함된 뮤테이션용 입력 타입을 생성하세요
- 관계에서 N+1 쿼리를 방지하기 위해 DataLoader를 추가하세요
"api-design-principles" 사용 중입니다. 검증 오류에 대해 내 API가 어떤 상태 코드를 반환해야 하나요?
예상 결과:
- 잘못된 요청 구문에 대해 400 Bad Request를 반환하세요
- 검증 실패에 대해 422 Unprocessable Entity를 반환하세요
- 응답 본문에 필드 수준 오류 세부 정보를 포함하세요
- 모든 엔드포인트에서 일관된 오류 형식을 사용하세요
보안 감사
안전This skill contains only educational documentation, code templates, and best practices for API design. All 233 static findings are false positives: 'weak cryptographic algorithm' flags educational password hashing examples; 'backtick execution' misinterprets markdown code formatting; 'system reconnaissance' triggers on legitimate programming terms like fetch/decode; hardcoded URLs/IPs are documentation examples, not actual network calls. No executable code, network calls, or data access patterns pose security risks.
위험 요인
🌐 네트워크 접근 (7)
⚙️ 외부 명령어 (134)
품질 점수
만들 수 있는 것
새로운 API 표준 정의
구현 전에 팀을 위한 일관된 REST 및 GraphQL 규칙을 생성합니다.
API 사양 검토
명명, 버전 관리 및 오류 처리 문제에 대한 사형을 감사합니다.
API 사용성 개선
엔드포인트와 스키마를 개선하여 클라이언트 혼란과 재작업을 줄입니다.
이 프롬프트를 사용해 보세요
이 REST API 개요를 검토하고 명명, 메서드 및 상태 코드 수정 사항을 나열하세요. 짧은 수정된 예제를 제공하세요.
이 GraphQL 스키마를 페이지네이션, 입력 타입 및 오류 패턴에 대해 평가하세요. 짧은 예제와 함께 개선 사항을 제안하세요.
이 API에 대한 버전 관리 접근 방식을 추천하고 트레이드오프를 설명하세요. 마이그레이션 체크리스트를 제공하세요.
API 설계 체크리스트를 이 사양에 적용하고 실패한 각 항목에 대한 수정 사항과 함께 통과 또는 실패를 반환하세요.
모범 사례
- 런칭 전에 버전 관리 및 사용 중단 규칙을 문서화하세요
- 안정적인 오류 코드가 포함된 일관된 오류 형식을 사용하세요
- 모든 컬렉션 엔드포인트를 명확한 제한으로 페이지네이션하세요
피하기
- 읽기 전용 연산에 POST 사용
- 두 수준을 넘어서는 깊이 중첩된 리소스 경로
- 엔드포인트 간 일관되지 않은 오류 형태 반환