스킬 api-design-principles
🧭

api-design-principles

안전 🌐 네트워크 접근⚙️ 외부 명령어

REST 및 GraphQL API를 자신 있게 설계하세요

API 설계 결정은 종종 일관성 없이 유지하기 어려워집니다. 이 스킬은 선택을 안내하기 위한 명확한 패턴, 템플릿 및 체크리스트를 제공합니다.

지원: Claude Codex Code(CC)
🥉 72 브론즈
1

스킬 ZIP 다운로드

2

Claude에서 업로드

설정 → 기능 → 스킬 → 스킬 업로드로 이동

3

토글을 켜고 사용 시작

테스트해 보기

"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를 반환하세요
  • 응답 본문에 필드 수준 오류 세부 정보를 포함하세요
  • 모든 엔드포인트에서 일관된 오류 형식을 사용하세요

보안 감사

안전
v4 • 1/17/2026

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.

6
스캔된 파일
2,011
분석된 줄 수
2
발견 사항
4
총 감사 수

위험 요인

🌐 네트워크 접근 (7)
⚙️ 외부 명령어 (134)
references/graphql-schema-design.md:6-35 references/graphql-schema-design.md:35-40 references/graphql-schema-design.md:40-48 references/graphql-schema-design.md:48-51 references/graphql-schema-design.md:51-72 references/graphql-schema-design.md:72-75 references/graphql-schema-design.md:75-99 references/graphql-schema-design.md:99-102 references/graphql-schema-design.md:102-122 references/graphql-schema-design.md:122-127 references/graphql-schema-design.md:127-171 references/graphql-schema-design.md:171-174 references/graphql-schema-design.md:174-185 references/graphql-schema-design.md:185-190 references/graphql-schema-design.md:190-212 references/graphql-schema-design.md:212-215 references/graphql-schema-design.md:215-231 references/graphql-schema-design.md:231-234 references/graphql-schema-design.md:234-254 references/graphql-schema-design.md:254-259 references/graphql-schema-design.md:259-296 references/graphql-schema-design.md:296-299 references/graphql-schema-design.md:299-314 references/graphql-schema-design.md:314-318 references/graphql-schema-design.md:318-343 references/graphql-schema-design.md:343-347 references/graphql-schema-design.md:347-364 references/graphql-schema-design.md:364-369 references/graphql-schema-design.md:369-388 references/graphql-schema-design.md:388-391 references/graphql-schema-design.md:391-404 references/graphql-schema-design.md:404-409 references/graphql-schema-design.md:409-452 references/graphql-schema-design.md:452-455 references/graphql-schema-design.md:455-474 references/graphql-schema-design.md:474-479 references/graphql-schema-design.md:479-493 references/graphql-schema-design.md:493-496 references/graphql-schema-design.md:496-507 references/graphql-schema-design.md:507-510 references/graphql-schema-design.md:510-520 references/graphql-schema-design.md:520-525 references/graphql-schema-design.md:525-531 references/graphql-schema-design.md:531-534 references/graphql-schema-design.md:534-553 references/graphql-schema-design.md:553-562 references/rest-best-practices.md:6-16 references/rest-best-practices.md:16-19 references/rest-best-practices.md:19-28 references/rest-best-practices.md:28-33 references/rest-best-practices.md:33-37 references/rest-best-practices.md:37-40 references/rest-best-practices.md:40-50 references/rest-best-practices.md:50-53 references/rest-best-practices.md:53-60 references/rest-best-practices.md:60-63 references/rest-best-practices.md:63-68 references/rest-best-practices.md:68-71 references/rest-best-practices.md:71-76 references/rest-best-practices.md:76-81 references/rest-best-practices.md:81-97 references/rest-best-practices.md:97-102 references/rest-best-practices.md:102-113 references/rest-best-practices.md:113-116 references/rest-best-practices.md:116-125 references/rest-best-practices.md:125-128 references/rest-best-practices.md:128-136 references/rest-best-practices.md:136-141 references/rest-best-practices.md:141-147 references/rest-best-practices.md:147-150 references/rest-best-practices.md:150-156 references/rest-best-practices.md:156-159 references/rest-best-practices.md:159-164 references/rest-best-practices.md:164-169 references/rest-best-practices.md:169-177 references/rest-best-practices.md:177-180 references/rest-best-practices.md:180-217 references/rest-best-practices.md:217-222 references/rest-best-practices.md:222-227 references/rest-best-practices.md:227-230 references/rest-best-practices.md:230-232 references/rest-best-practices.md:232-237 references/rest-best-practices.md:237-253 references/rest-best-practices.md:253-256 references/rest-best-practices.md:256-257 references/rest-best-practices.md:257-258 references/rest-best-practices.md:258-259 references/rest-best-practices.md:259-260 references/rest-best-practices.md:260-261 references/rest-best-practices.md:261-262 references/rest-best-practices.md:262-263 references/rest-best-practices.md:263-264 references/rest-best-practices.md:264-265 references/rest-best-practices.md:265-266 references/rest-best-practices.md:266-267 references/rest-best-practices.md:267-272 references/rest-best-practices.md:272-283 references/rest-best-practices.md:283-288 references/rest-best-practices.md:288-304 references/rest-best-practices.md:304-309 references/rest-best-practices.md:309-315 references/rest-best-practices.md:315-319 references/rest-best-practices.md:319-329 references/rest-best-practices.md:329-333 references/rest-best-practices.md:333-362 references/rest-best-practices.md:362-366 references/rest-best-practices.md:366-385 SKILL.md:31 SKILL.md:32 SKILL.md:33 SKILL.md:34 SKILL.md:35 SKILL.md:54-57 SKILL.md:57-60 SKILL.md:60-62 SKILL.md:62-65 SKILL.md:65-67 SKILL.md:67-73 SKILL.md:73-90 SKILL.md:90-94 SKILL.md:94-151 SKILL.md:151-155 SKILL.md:155-212 SKILL.md:212-216 SKILL.md:216-242 SKILL.md:242-248 SKILL.md:248-349 SKILL.md:349-353 SKILL.md:353-442 SKILL.md:442-446 SKILL.md:446-487 SKILL.md:487-492 SKILL.md:492 SKILL.md:492-506
감사자: claude 감사 이력 보기 →

품질 점수

55
아키텍처
90
유지보수성
85
콘텐츠
21
커뮤니티
100
보안
87
사양 준수

만들 수 있는 것

새로운 API 표준 정의

구현 전에 팀을 위한 일관된 REST 및 GraphQL 규칙을 생성합니다.

API 사양 검토

명명, 버전 관리 및 오류 처리 문제에 대한 사형을 감사합니다.

API 사용성 개선

엔드포인트와 스키마를 개선하여 클라이언트 혼란과 재작업을 줄입니다.

이 프롬프트를 사용해 보세요

REST 기초 검토
이 REST API 개요를 검토하고 명명, 메서드 및 상태 코드 수정 사항을 나열하세요. 짧은 수정된 예제를 제공하세요.
GraphQL 스키마 확인
이 GraphQL 스키마를 페이지네이션, 입력 타입 및 오류 패턴에 대해 평가하세요. 짧은 예제와 함께 개선 사항을 제안하세요.
버전 관리 전략
이 API에 대한 버전 관리 접근 방식을 추천하고 트레이드오프를 설명하세요. 마이그레이션 체크리스트를 제공하세요.
설계 체크리스트 실행
API 설계 체크리스트를 이 사양에 적용하고 실패한 각 항목에 대한 수정 사항과 함께 통과 또는 실패를 반환하세요.

모범 사례

  • 런칭 전에 버전 관리 및 사용 중단 규칙을 문서화하세요
  • 안정적인 오류 코드가 포함된 일관된 오류 형식을 사용하세요
  • 모든 컬렉션 엔드포인트를 명확한 제한으로 페이지네이션하세요

피하기

  • 읽기 전용 연산에 POST 사용
  • 두 수준을 넘어서는 깊이 중첩된 리소스 경로
  • 엔드포인트 간 일관되지 않은 오류 형태 반환

자주 묻는 질문

이것은 Claude, Codex 및 Claude Code와 호환되나요?
네. 이 가이드는 플랫폼에 구애받지 않으며 Claude, Codex 및 Claude Code에서 작동합니다.
이 스킬의 한계는 무엇인가요?
패턴과 템플릿을 제공하지만 완전한 작동 API 서비스를 생성하지는 않습니다.
이를 기존 코드베이스와 통합할 수 있나요?
네. 체크리스트와 템플릿을 사용하여 기존 엔드포인트 및 스키마를 정렬할 수 있습니다.
민감한 데이터에 접근하거나 저장하나요?
아니요. 정적 가이드와 예제만 제공합니다.
내 API 설계가 다루어지지 않으면 어떻게 해야 하나요?
사양과 목표를 제공하고-targeted 추천을 요청하세요.
일반적인 API 조언과 어떻게 비교되나요?
체크리스트와 템플릿이 포함된 구체적인 REST 및 GraphQL 패턴을 제공합니다.