API 설계 리뷰어
OpenAPI 스펙을 린팅하고 breaking change를 잡아내며 설계 품질을 등급으로 매겨주는 REST API 리뷰 스킬.
웹·API 연동중급★ 24,151⑂ 3,405AI 점수 8/10마지막 업데이트: 2026. 8. 9.
무엇을 해주나
REST API 설계를 세 가지 도구로 자동 점검합니다.
- api_linter.py: 리소스 네이밍(kebab-case), 필드 네이밍(camelCase), HTTP 메서드 사용, 상태 코드, 에러 응답 포맷, 문서 누락 여부를 검사합니다.
- breaking_change_detector.py: v1과 v2 스펙을 비교해 엔드포인트 삭제, 필드 제거·타입 변경, 필수 필드 추가 등 클라이언트를 깨뜨릴 변경을 찾아냅니다.
--exit-on-breaking으로 CI 게이트로 쓸 수 있습니다. - api_scorecard.py: 일관성(30%), 문서화(20%), 보안(20%), 사용성(15%), 성능(15%) 기준으로 A~F 등급을 매깁니다.
또한 버저닝 전략, 페이지네이션 패턴(offset/cursor/page), 표준 에러 구조, 인증·레이트리밋 헤더, HATEOAS, 멱등성 키, 하위 호환 규칙까지 참조 문서로 담고 있어 팀 API 표준 문서의 초안으로도 쓸 수 있습니다.
이런 분께 추천
- API 엔드포인트를 추가·변경하는 PR을 리뷰해야 하는 백엔드 개발자·테크리드
- v2 마이그레이션을 앞두고 기존 API를 감사해야 하는 팀
- 사내 API 컨벤션을 처음 정립하려는 플랫폼/아키텍처 담당자
활용 예시
- PR 리뷰 게이트: "이 PR의 openapi.json을 린트하고 main 브랜치 스펙과 비교해 breaking change가 있는지 알려줘" → 린터 결과 + 깨지는 변경 목록 + 등급을 함께 리포트.
- v2 마이그레이션 감사: 기존 스펙에 스코어카드를 돌려 B 미만 항목(문서 누락, 페이지네이션 부재 등)을 뽑고 개선 우선순위를 정리.
- CI 파이프라인 삽입: GitHub Actions 스텝에
--min-grade B와--exit-on-breaking을 걸어 규칙 위반 시 빌드를 실패시키기.
· · · 설치 가이드 · · ·
Claude 앱에 설치 (터미널 필요 없음)
- 아래 버튼으로 ZIP 파일을 받으세요.
- Claude 설정 → Capabilities에서 '코드 실행 및 파일 생성'을 켭니다. (한 번만)
- Claude에서 Customize → Skills → + → '스킬 업로드'를 누르고 받은 ZIP을 올립니다.
Claude Code에 설치
Claude에게 맡기기 — 아래 문장을 Claude Code에 붙여넣으세요
클로드스킬마트에서 찾은 스킬을 설치해줘. GitHub 저장소 alirezarezvani/claude-skills 의 .gemini/skills/api-design-reviewer 폴더를 내 ~/.claude/skills/api-design-reviewer/ 에 그대로 복사해줘. 설치가 끝나면 이 스킬로 무엇을 할 수 있는지 한 줄로 알려줘.
직접 명령으로 설치하기
git clone https://github.com/alirezarezvani/claude-skills.git /tmp/claude-skills && mkdir -p ~/.claude/skills && cp -r /tmp/claude-skills/.gemini/skills/api-design-reviewer ~/.claude/skills/⚠ 제3자가 만든 스킬입니다. 설치 전 원본 저장소를 한 번 확인하세요.
- 터미널을 엽니다.
- 저장소를 임시 폴더로 내려받습니다:
git clone https://github.com/alirezarezvani/claude-skills.git /tmp/claude-skills - 스킬 폴더를 만듭니다:
mkdir -p ~/.claude/skills - 스킬을 복사합니다:
cp -r /tmp/claude-skills/.gemini/skills/api-design-reviewer ~/.claude/skills/ ls ~/.claude/skills/api-design-reviewer/scripts로 파이썬 스크립트(api_linter.py 등)가 함께 복사됐는지 확인합니다. 없다면 저장소 내 다른 경로(engineering/skills/...)에서 scripts 폴더를 찾아 함께 복사하세요.- Python 3가 설치돼 있는지 확인합니다:
python3 --version - Claude Code를 재시작한 뒤 "이 OpenAPI 스펙을 API 설계 관점에서 리뷰해줘"라고 요청하면 스킬이 동작합니다.
GitHub에서 원본 보기 ↗라이선스: MIT