클로드스킬마트스킬 둘러보기바로 쓰는 문장영상으로 배우기터미널 사용법스킬이 뭐예요?
 
← 목록으로

API 설계 컨벤션 가이드

REST URL 명명, 응답 포맷, 상태 코드, 인증 규칙을 Claude가 항상 따르게 만드는 API 컨벤션 스킬입니다.

개발·코딩입문★ 1,078⑂ 379AI 점수 7/10마지막 업데이트: 2026. 7. 23.

무엇을 해주나

  • API 엔드포인트를 작성하거나 리뷰할 때 프로젝트 표준을 자동으로 적용합니다.
  • URL 명명 규칙(복수 명사, kebab-case, 중첩 2단계 제한, 필터는 쿼리 파라미터)을 강제합니다.
  • 모든 응답을 data / error / meta 구조의 고정 포맷으로 통일하고, 목록 API에는 페이지네이션 메타를 요구합니다.
  • HTTP 상태 코드 사용 기준(200/201/400/401/403/404/422/500)과 인증 규칙(Bearer 토큰, @public 주석), URL 버저닝(/api/v1/...) 방침을 알려줍니다.

이런 분께 추천

  • 백엔드 API를 여러 명이 함께 만들면서 스타일이 제각각인 팀
  • 코드 리뷰에서 매번 같은 API 지적을 반복하는 리드 개발자
  • 새 서비스의 API 규약을 빠르게 세우고 문서화하려는 개발자
  • Claude Code로 엔드포인트 스캐폴딩을 자주 생성하는 사람

활용 예시

  1. "주문 목록 조회 엔드포인트 만들어줘" → /api/v1/orders?status=active&limit=20 형태와 data/error/meta 응답 래퍼로 생성됩니다.
  2. "이 PR의 API 부분 리뷰해줘" → /getUserOrder 같은 동사형·단수형 URL, 누락된 401/422 처리, meta 없는 목록 응답을 지적합니다.
  3. "이 엔드포인트는 로그인 없이 열어도 될까?" → 공개 엔드포인트에 @public 표기와 문서화가 필요하다고 안내합니다.

· · · 설치 가이드 · · ·

설치 없이 지금 한 번 써보기

아래를 Claude에 붙여넣으면 설치하지 않고도 이 스킬을 그대로 씁니다.

이 파일의 지시를 읽고 그대로 따라서 나를 도와줘:
https://raw.githubusercontent.com/huangjia2019/claude-code-engineering/HEAD/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions/SKILL.md

내가 원하는 것: (여기에 하고 싶은 일을 쓰세요)

Claude가 링크를 열지 못하면, 링크를 직접 열어 내용을 복사해 붙여넣으세요.

↓ 쓸 만하면 아래에서 ZIP을 받아 설치하세요. 그러면 매번 붙여넣지 않아도 알아서 작동합니다.

Claude 앱에 설치 (터미널 필요 없음)
  1. 아래 버튼으로 ZIP 파일을 받으세요.
  2. Claude 설정 → Capabilities에서 '코드 실행 및 파일 생성'을 켭니다. (한 번만)
  3. Claude에서 Customize → Skills → + → '스킬 업로드'를 누르고 받은 ZIP을 올립니다.
↓ ZIP 내려받기
Claude Code에 설치

Claude에게 맡기기 — 아래 문장을 Claude Code에 붙여넣으세요

클로드스킬마트에서 찾은 스킬을 설치해줘.
GitHub 저장소 huangjia2019/claude-code-engineering 의 04-Skills/projects/01-reference-skill/.claude/skills/api-conventions 폴더를 내 ~/.claude/skills/api-conventions/ 에 그대로 복사해줘.
설치가 끝나면 이 스킬로 무엇을 할 수 있는지 한 줄로 알려줘.

직접 명령으로 설치하기

git clone https://github.com/huangjia2019/claude-code-engineering.git && mkdir -p ~/.claude/skills/api-conventions && cp claude-code-engineering/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions/SKILL.md ~/.claude/skills/api-conventions/

⚠ 제3자가 만든 스킬입니다. 설치 전 원본 저장소를 한 번 확인하세요.

  1. 터미널을 엽니다.
  2. 저장소를 내려받습니다: git clone https://github.com/huangjia2019/claude-code-engineering.git
  3. 스킬 폴더를 만듭니다: mkdir -p ~/.claude/skills/api-conventions
  4. 파일을 복사합니다: cp claude-code-engineering/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions/SKILL.md ~/.claude/skills/api-conventions/
  5. (권장) SKILL.md를 열어 응답 포맷·상태 코드·인증 규칙을 우리 팀 표준으로 수정합니다.
  6. Claude Code를 다시 실행하고 "이 API 엔드포인트 컨벤션에 맞는지 검토해줘"라고 요청해 동작을 확인합니다.
  7. 프로젝트 단위로만 쓰고 싶다면 ~/.claude 대신 프로젝트 루트의 .claude/skills/에 넣으세요.
GitHub에서 원본 보기 ↗