rest-api

KubrickCode

更新日 Today

229 閲覧

開発api

について

このスキルは、開発者向けに包括的なREST API設計基準と実装ガイダンスを提供します。RESTfulの原則、URL構造、HTTPメソッド、ページネーション、フィルタリング、エラー処理、OpenAPIドキュメントについて網羅しています。APIを設計する際、エンドポイントを定義する際、ページネーションを実装する際、または一貫したレスポンスとエラー処理戦略を確立する際にご利用ください。

クイックインストール

Claude Code

推奨

プラグインコマンド推奨

/plugin add https://github.com/KubrickCode/ai-config-toolkit

Git クローン代替

git clone https://github.com/KubrickCode/ai-config-toolkit.git ~/.claude/skills/rest-api

このコマンドをClaude Codeにコピー＆ペーストしてスキルをインストールします

ドキュメント

REST API Design Standards

네이밍 규칙

필드 네이밍

boolean: is/has/can 접두사 강제
날짜: ~At 접미사 강제
같은 개념은 프로젝트 전체 동일 용어 (create vs add 중 하나로 통일)

날짜 형식

ISO 8601 UTC
DateTime 타입 사용

페이지네이션

커서 기반 사용 (업계 표준)

파라미터: ?cursor=xyz&limit=20
응답: { data: [...], nextCursor: "abc", hasNext: true }

정렬

?sortBy=createdAt&sortOrder=desc
복수 정렬 지원
기본값 명시

필터

범위: { min, max } 또는 { gte, lte }
복잡한 조건은 중첩 객체

URL 구조

중첩 리소스

최대 2단계

액션

리소스로 표현 불가시만 동사 허용
/users/:id/activate

응답

data + 페이지네이션 정보

생성

201 + 리소스 (민감정보 제외)

에러 (RFC 7807 ProblemDetail)

필수: type, title, status, detail, instance
선택: errors 배열

배치

/batch 서픽스
성공/실패 개수 + 결과

GitHub リポジトリ

KubrickCode/ai-config-toolkit

パス: .claude.kr/skills/rest-api