API 설계 리뷰어
OpenAPI 스펙을 린트하고 호환성 파괴 변경을 잡아내며 설계 품질에 등급을 매겨 REST API 리뷰를 자동화합니다.
개발·코딩중급★ 24,151⑂ 3,405AI 점수 7/10마지막 업데이트: 2026. 8. 9.
무엇을 해주나
- OpenAPI/Swagger 스펙을 린트해 리소스 명명(kebab-case), 필드 명명(camelCase), HTTP 메서드 사용, 상태 코드, 에러 포맷, 문서 누락을 점검합니다.
- 두 버전의 스펙을 비교해 엔드포인트 삭제, 필드 제거·타입 변경, 필수 필드 추가 같은 호환성 파괴 변경을 탐지하고
--exit-on-breaking으로 게이트를 걸 수 있습니다. - 일관성(30%)·문서화(20%)·보안(20%)·사용성(15%)·성능(15%) 가중치로 A~F 등급 스코어카드를 산출합니다.
- 버전 전략, 페이지네이션 패턴, 에러 응답 표준, 인증·레이트리밋 헤더, 캐싱, 안티패턴 목록 등 리뷰 판단 기준을 함께 제공합니다.
이런 분께 추천
- API 엔드포인트를 추가·수정하는 PR을 리뷰해야 하는 백엔드 개발자·테크리드
- v2 마이그레이션을 앞두고 기존 API를 감사해야 하는 팀
- 팀 차원의 API 설계 표준을 문서 대신 자동 검사로 강제하고 싶은 조직
활용 예시
python3 scripts/api_linter.py openapi.json --format json -o lint.json으로 PR의 스펙 위반을 목록화해 리뷰 코멘트로 첨부.- v1과 v2 스펙을 비교해 호환성 파괴 변경을 뽑고, 버전 범프가 필요한 항목과 마이그레이션 가이드를 정리.
- CI에 스코어카드를 넣고
--min-grade B미달 시 빌드를 실패시켜 설계 품질 하한선을 유지.
· · · 설치 가이드 · · ·
설치 없이 지금 한 번 써보기
아래를 Claude에 붙여넣으면 설치하지 않고도 이 스킬을 그대로 씁니다.
이 파일의 지시를 읽고 그대로 따라서 나를 도와줘: https://raw.githubusercontent.com/alirezarezvani/claude-skills/HEAD/.gemini/skills/api-design-reviewer/SKILL.md 내가 원하는 것: (여기에 하고 싶은 일을 쓰세요)
Claude가 링크를 열지 못하면, 링크를 직접 열어 내용을 복사해 붙여넣으세요.
↓ 쓸 만하면 아래에서 ZIP을 받아 설치하세요. 그러면 매번 붙여넣지 않아도 알아서 작동합니다.
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 - 스킬 폴더를 생성합니다:
mkdir -p ~/.claude/skills - 스킬을 복사합니다:
cp -r claude-skills/.gemini/skills/api-design-reviewer ~/.claude/skills/ ~/.claude/skills/api-design-reviewer/scripts/안에api_linter.py,breaking_change_detector.py,api_scorecard.py가 있는지 확인합니다(없으면 저장소의 다른 경로에서 찾아 복사).python3 --version으로 파이썬 3이 설치되어 있는지 확인합니다.- Claude Code를 재시작하고 "이 OpenAPI 스펙으로 API 설계 리뷰해줘"처럼 요청합니다.
GitHub에서 원본 보기 ↗라이선스: MIT