rest-api
About
This skill provides comprehensive REST API design standards and implementation guidance for developers. It covers RESTful principles, URL structures, HTTP methods, pagination, filtering, error handling, and OpenAPI documentation. Use it when designing APIs, defining endpoints, implementing pagination, or establishing consistent response and error handling strategies.
Documentation
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서픽스- 성공/실패 개수 + 결과
Quick Install
/plugin add https://github.com/KubrickCode/ai-config-toolkit/tree/main/rest-apiCopy and paste this command in Claude Code to install this skill
GitHub 仓库
Related Skills
evaluating-llms-harness
TestingThis Claude Skill runs the lm-evaluation-harness to benchmark LLMs across 60+ standardized academic tasks like MMLU and GSM8K. It's designed for developers to compare model quality, track training progress, or report academic results. The tool supports various backends including HuggingFace and vLLM models.
langchain
MetaLangChain is a framework for building LLM applications using agents, chains, and RAG pipelines. It supports multiple LLM providers, offers 500+ integrations, and includes features like tool calling and memory management. Use it for rapid prototyping and deploying production systems like chatbots, autonomous agents, and question-answering services.
nestjs
MetaThis skill provides NestJS development standards and architectural patterns for building domain-centric applications. It covers modular design, dependency injection, decorator patterns, and key framework features like controllers, services, middleware, and interceptors. Use it when developing NestJS applications, implementing APIs, configuring microservices, or integrating with databases.
huggingface-accelerate
DevelopmentHuggingFace Accelerate provides the simplest API for adding distributed training to PyTorch scripts with just 4 lines of code. It offers a unified interface for multiple distributed training frameworks like DeepSpeed, FSDP, and DDP while handling automatic device placement and mixed precision. This makes it ideal for developers who want to quickly scale their PyTorch training across multiple GPUs or nodes without complex configuration.
