API·인터페이스 설계 가이드
REST/GraphQL 엔드포인트와 모듈 경계를 오용하기 어렵고 오래 가는 계약으로 설계하도록 돕는 스킬입니다.
개발·코딩중급★ 423⑂ 45AI 점수 8/10마지막 업데이트: 2026. 9. 13.
무엇을 해주나
Claude가 API나 모듈 인터페이스를 설계할 때 따라야 할 원칙과 점검 항목을 주입합니다.
- 계약 우선 설계: 구현 전에 입력·출력 타입 계약을 먼저 정의
- 일관된 에러 규격:
{ error: { code, message, details } }형태와 HTTP 상태코드 매핑 표 - 경계에서만 검증: 라우트 핸들러·폼·외부 API 응답·환경변수에서 검증하고 내부는 타입을 신뢰
- 확장 우선: 필드 제거·타입 변경 대신 선택적 필드 추가로 하위 호환 유지
- 멱등성 키 실전 처리: 키 파생 규칙, 유니크 제약을 이용한 원자적 클레임, 페이로드 해시 검증, 진행 중 중복 요청 대응(409/대기/202), 보존 기간 설계
- 네이밍 규약 표, 흔한 변명 반박 표, 레드 플래그 목록, 최종 검증 체크리스트
이런 분께 추천
- REST/GraphQL 백엔드를 새로 설계하거나 리팩터링하는 개발자
- 팀 간 모듈 경계·타입 계약을 정해야 하는 테크 리드
- 결제·주문처럼 재시도 시 중복이 치명적인 기능을 만드는 분
- API 리뷰어로서 일관성 기준이 필요한 분
활용 예시
- "작업(Task) 관리 REST API를 설계해줘" → 리소스 경로, 페이지네이션 응답 형태, PATCH 부분 업데이트, 에러 바디까지 일관된 스펙 산출
- "결제 생성 엔드포인트에 Idempotency-Key를 붙이고 싶어" → 키 파생 방식,
INSERT유니크 제약 기반 원자적 클레임, 동일 키 다른 바디 422 처리까지 제안 - "기존 API에 필드를 추가해도 안전할까?" → 하위 호환 규칙과 Hyrum의 법칙 관점에서 위험 요소 점검
· · · 설치 가이드 · · ·
설치 없이 지금 한 번 써보기
아래를 Claude에 붙여넣으면 설치하지 않고도 이 스킬을 그대로 씁니다.
이 파일의 지시를 읽고 그대로 따라서 나를 도와줘: https://raw.githubusercontent.com/aiskillstore/marketplace/HEAD/pending/addyosmani/api-and-interface-design/SKILL.md 내가 원하는 것: (여기에 하고 싶은 일을 쓰세요)
Claude가 링크를 열지 못하면, 링크를 직접 열어 내용을 복사해 붙여넣으세요.
↓ 쓸 만하면 아래에서 ZIP을 받아 설치하세요. 그러면 매번 붙여넣지 않아도 알아서 작동합니다.
Claude 앱에 설치 (터미널 필요 없음)
- 아래 버튼으로 ZIP 파일을 받으세요.
- Claude 설정 → Capabilities에서 '코드 실행 및 파일 생성'을 켭니다. (한 번만)
- Claude에서 Customize → Skills → + → '스킬 업로드'를 누르고 받은 ZIP을 올립니다.
Claude Code에 설치
Claude에게 맡기기 — 아래 문장을 Claude Code에 붙여넣으세요
클로드스킬마트에서 찾은 스킬을 설치해줘. GitHub 저장소 aiskillstore/marketplace 의 pending/addyosmani/api-and-interface-design 폴더를 내 ~/.claude/skills/api-and-interface-design/ 에 그대로 복사해줘. 설치가 끝나면 이 스킬로 무엇을 할 수 있는지 한 줄로 알려줘.
직접 명령으로 설치하기
git clone https://github.com/aiskillstore/marketplace.git && mkdir -p ~/.claude/skills && cp -r marketplace/pending/addyosmani/api-and-interface-design ~/.claude/skills/⚠ 제3자가 만든 스킬입니다. 설치 전 원본 저장소를 한 번 확인하세요.
- 터미널을 엽니다.
- 저장소를 내려받습니다:
git clone https://github.com/aiskillstore/marketplace.git - 스킬 폴더를 만듭니다:
mkdir -p ~/.claude/skills - 스킬을 복사합니다:
cp -r marketplace/pending/addyosmani/api-and-interface-design ~/.claude/skills/ ~/.claude/skills/api-and-interface-design/SKILL.md파일이 있는지 확인합니다.- Claude Code를 다시 실행한 뒤 "REST API를 설계해줘"처럼 요청하면 스킬이 자동으로 참조됩니다.