api-design

---
name: api-design
description: REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.
origin: ECC
---

# API 설계 패턴

일관되고 개발자 친화적인 REST API를 설계하기 위한 규칙과 모범 사례입니다.

## 활성화 시점

- 새로운 API 엔드포인트 설계 시
- 기존 API 계약 검토 시
- 페이지네이션, 필터링 또는 정렬 추가 시
- API를 위한 오류 처리 구현 시
- API 버전 관리 전략 계획 시
- 공개 또는 파트너 대상 API 구축 시

## 리소스 설계

### URL 구조

```
# Resources are nouns, plural, lowercase, kebab-case
GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
PATCH  /api/v1/users/:id
DELETE /api/v1/users/:id

# Sub-resources for relationships
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# Actions that don't map to CRUD (use verbs sparingly)
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh
```

### 명명 규칙

```
# GOOD
/api/v1/team-members          # kebab-case for multi-word resources
/api/v1/orders?status=active  # query params for filtering
/api/v1/users/123/orders      # nested resources for ownership

# BAD
/api/v1/getUsers              # verb in URL
/api/v1/user                  # singular (use plural)
/api/v1/team_members          # snake_case in URLs
/api/v1/users/123/getOrders   # verb in nested resource
```

## HTTP 메서드와 상태 코드

### 메서드 의미

| 메서드 | 멱등성 | 안전 | 용도 |
|--------|-----------|------|---------|
| GET | Yes | Yes | 리소스 조회 |
| POST | No | No | 리소스 생성, 액션 트리거 |
| PUT | Yes | No | 리소스 전체 교체 |
| PATCH | No* | No | 리소스 부분 업데이트 |
| DELETE | Yes | No | 리소스 삭제 |

*PATCH는 적절한 구현으로 멱등성을 가질 수 있습니다

### 상태 코드 참조

```
# Success
200 OK                    — GET, PUT, PATCH (응답 본문 포함)
201 Created               — POST (Location 헤더 포함)
204 No Content            — DELETE, PUT (응답 본문 없음)

# Client Errors
400 Bad Request           — 유효성 검증 실패, 잘못된 JSON
401 Unauthorized          — 인증 누락 또는 잘못된 인증
403 Forbidden             — 인증되었지만 권한 없음
404 Not Found             — 리소스가 존재하지 않음
409 Conflict              — 중복 항목, 상태 충돌
422 Unprocessable Entity  — 의미적으로 유효하지 않음 (유효한 JSON, 잘못된 데이터)
429 Too Many Requests     — 요청 제한 초과

# Server Errors
500 Internal Server Error — 예기치 않은 오류 (세부 사항 노출 금지)
502 Bad Gateway           — 업스트림 서비스 실패
503 Service Unavailable   — 일시적 과부하, Retry-After 포함
```

### 흔한 실수

```
# BAD: 200 for everything
{ "status": 200, "success": false, "error": "Not found" }

# GOOD: Use HTTP status codes semantically
HTTP/1.1 404 Not Found
{ "error": { "code": "not_found", "message": "User not found" } }

# BAD: 500 for validation errors
# GOOD: 400 or 422 with field-level details

# BAD: 200 for created resources
# GOOD: 201 with Location header
HTTP/1.1 201 Created
Location: /api/v1/users/abc-123
```

## 응답 형식

### 성공 응답

```json
{
  "data": {
    "id": "abc-123",
    "email": "alice@example.com",
    "name": "Alice",
    "created_at": "2025-01-15T10:30:00Z"
  }
}
```

### 컬렉션 응답 (페이지네이션 포함)

```json
{
  "data": [
    { "id": "abc-123", "name": "Alice" },
    { "id": "def-456", "name": "Bob" }
  ],
  "meta": {
    "total": 142,
    "page": 1,
    "per_page": 20,
    "total_pages": 8
  },
  "links": {
    "self": "/api/v1/users?page=1&per_page=20",
    "next": "/api/v1/users?page=2&per_page=20",
    "last": "/api/v1/users?page=8&per_page=20"
  }
}
```

### 오류 응답

```json
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "details": [
      {
        "field": "email",
        "message": "Must be a valid email address",
        "code": "invalid_format"
      },
      {
        "field": "age",
        "message": "Must be between 0 and 150",
        "code": "out_of_range"
      }
    ]
  }
}
```

### 응답 래퍼 변형

```typescript
// Option A: Envelope with data wrapper (공개 API에 권장)
interface ApiResponse<T> {
  data: T;
  meta?: PaginationMeta;
  links?: PaginationLinks;
}

interface ApiError {
  error: {
    code: string;
    message: string;
    details?: FieldError[];
  };
}

// Option B: Flat response (더 단순함, 내부 API에서 흔히 사용)
// Success: just return the resource directly
// Error: return error object
// Distinguish by HTTP status code
```

## 페이지네이션

### 오프셋 기반 (단순)

```
GET /api/v1/users?page=2&per_page=20

# Implementation
SELECT * FROM users
ORDER BY created_at DESC
LIMIT 20 OFFSET 20;
```

**장점:** 구현이 쉽고 "N 페이지로 이동" 지원
**단점:** 큰 오프셋에서 느림 (OFFSET 100000), 동시 삽입 시 일관성 없음

### 커서 기반 (확장 가능)

```
GET /api/v1/users?cursor=eyJpZCI6MTIzfQ&limit=20

# Implementation
SELECT * FROM users
WHERE id > :cursor_id
ORDER BY id ASC
LIMIT 21;  -- fetch one extra to determine has_next
```

```json
{
  "data": [...],
  "meta": {
    "has_next": true,
    "next_cursor": "eyJpZCI6MTQzfQ"
  }
}
```

**장점:** 위치에 관계없이 일관된 성능, 동시 삽입에도 안정적
**단점:** 임의 페이지로 이동 불가, 커서가 불투명함

### 언제 어떤 것을 사용할지

| 사용 사례 | 페이지네이션 유형 |
|----------|----------------|
| 관리자 대시보드, 소규모 데이터셋 (<10K) | 오프셋 |
| 무한 스크롤, 피드, 대규모 데이터셋 | 커서 |
| 공개 API | 커서 (기본) + 오프셋 (선택) |
| 검색 결과 | 오프셋 (사용자가 페이지 번호를 기대) |

## 필터링, 정렬 및 검색

### 필터링

```
# Simple equality
GET /api/v1/orders?status=active&customer_id=abc-123

# Comparison operators (use bracket notation)
GET /api/v1/products?price[gte]=10&price[lte]=100
GET /api/v1/orders?created_at[after]=2025-01-01

# Multiple values (comma-separated)
GET /api/v1/products?category=electronics,clothing

# Nested fields (dot notation)
GET /api/v1/orders?customer.country=US
```

### 정렬

```
# Single field (prefix - for descending)
GET /api/v1/products?sort=-created_at

# Multiple fields (comma-separated)
GET /api/v1/products?sort=-featured,price,-created_at
```

### 전문 검색

```
# Search query parameter
GET /api/v1/products?q=wireless+headphones

# Field-specific search
GET /api/v1/users?email=alice
```

### 희소 필드셋

```
# Return only specified fields (reduces payload)
GET /api/v1/users?fields=id,name,email
GET /api/v1/orders?fields=id,total,status&include=customer.name
```

## 인증 및 인가

### 토큰 기반 인증

```
# Bearer token in Authorization header
GET /api/v1/users
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

# API key (for server-to-server)
GET /api/v1/data
X-API-Key: sk_live_abc123
```

### 인가 패턴

```typescript
// Resource-level: check ownership
app.get("/api/v1/orders/:id", async (req, res) => {
  const order = await Order.findById(req.params.id);
  if (!order) return res.status(404).json({ error: { code: "not_found" } });
  if (order.userId !== req.user.id) return res.status(403).json({ error: { code: "forbidden" } });
  return res.json({ data: order });
});

// Role-based: check permissions
app.delete("/api/v1/users/:id", requireRole("admin"), async (req, res) => {
  await User.delete(req.params.id);
  return res.status(204).send();
});
```

## 요청 제한

### 헤더

```
HTTP/1.1 200 OK
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

# When exceeded
HTTP/1.1 429 Too Many Requests
Retry-After: 60
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 60 seconds."
  }
}
```

### 요청 제한 티어

| 티어 | 제한 | 윈도우 | 사용 사례 |
|------|-------|--------|----------|
| Anonymous | 30/분 | IP 당 | 공개 엔드포인트 |
| Authenticated | 100/분 | 사용자 당 | 표준 API 접근 |
| Premium | 1000/분 | API 키 당 | 유료 API 플랜 |
| Internal | 10000/분 | 서비스 당 | 서비스 간 통신 |

## 버전 관리

### URL 경로 버전 관리 (권장)

```
/api/v1/users
/api/v2/users
```

**장점:** 명시적, 라우팅 쉬움, 캐시 가능
**단점:** 버전 간 URL 변경

### 헤더 버전 관리

```
GET /api/users
Accept: application/vnd.myapp.v2+json
```

**장점:** 깔끔한 URL
**단점:** 테스트가 어렵고, 잊기 쉬움

### 버전 관리 전략

```
1. /api/v1/로 시작 — 필요할 때까지 버전 관리하지 않음
2. 최대 2개의 활성 버전 유지 (현재 + 이전)
3. 지원 종료 일정:
   - 지원 종료 공지 (공개 API의 경우 6개월 사전 통보)
   - Sunset 헤더 추가: Sunset: Sat, 01 Jan 2026 00:00:00 GMT
   - 종료일 이후 410 Gone 반환
4. 호환성 유지 변경은 새 버전 불필요:
   - 응답에 새 필드 추가
   - 새 선택적 쿼리 파라미터 추가
   - 새 엔드포인트 추가
5. 호환성 깨지는 변경은 새 버전 필요:
   - 필드 제거 또는 이름 변경
   - 필드 타입 변경
   - URL 구조 변경
   - 인증 방식 변경
```

## 구현 패턴

### TypeScript (Next.js API Route)

```typescript
import { z } from "zod";
import { NextRequest, NextResponse } from "next/server";

const createUserSchema = z.object({
  email: z.string().email(),
  name: z.string().min(1).max(100),
});

export async function POST(req: NextRequest) {
  const body = await req.json();
  const parsed = createUserSchema.safeParse(body);

  if (!parsed.success) {
    return NextResponse.json({
      error: {
        code: "validation_error",
        message: "Request validation failed",
        details: parsed.error.issues.map(i => ({
          field: i.path.join("."),
          message: i.message,
          code: i.code,
        })),
      },
    }, { status: 422 });
  }

  const user = await createUser(parsed.data);

  return NextResponse.json(
    { data: user },
    {
      status: 201,
      headers: { Location: `/api/v1/users/${user.id}` },
    },
  );
}
```

### Python (Django REST Framework)

```python
from rest_framework import serializers, viewsets, status
from rest_framework.response import Response

class CreateUserSerializer(serializers.Serializer):
    email = serializers.EmailField()
    name = serializers.CharField(max_length=100)

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ["id", "email", "name", "created_at"]

class UserViewSet(viewsets.ModelViewSet):
    serializer_class = UserSerializer
    permission_classes = [IsAuthenticated]

    def get_serializer_class(self):
        if self.action == "create":
            return CreateUserSerializer
        return UserSerializer

    def create(self, request):
        serializer = CreateUserSerializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        user = UserService.create(**serializer.validated_data)
        return Response(
            {"data": UserSerializer(user).data},
            status=status.HTTP_201_CREATED,
            headers={"Location": f"/api/v1/users/{user.id}"},
        )
```

### Go (net/http)

```go
func (h *UserHandler) CreateUser(w http.ResponseWriter, r *http.Request) {
    var req CreateUserRequest
    if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
        writeError(w, http.StatusBadRequest, "invalid_json", "Invalid request body")
        return
    }

    if err := req.Validate(); err != nil {
        writeError(w, http.StatusUnprocessableEntity, "validation_error", err.Error())
        return
    }

    user, err := h.service.Create(r.Context(), req)
    if err != nil {
        switch {
        case errors.Is(err, domain.ErrEmailTaken):
            writeError(w, http.StatusConflict, "email_taken", "Email already registered")
        default:
            writeError(w, http.StatusInternalServerError, "internal_error", "Internal error")
        }
        return
    }

    w.Header().Set("Location", fmt.Sprintf("/api/v1/users/%s", user.ID))
    writeJSON(w, http.StatusCreated, map[string]any{"data": user})
}
```

## API 설계 체크리스트

새 엔드포인트 배포 전:

- [ ] 리소스 URL이 명명 규칙을 따름 (복수형, kebab-case, 동사 없음)
- [ ] 올바른 HTTP 메서드 사용 (읽기는 GET, 생성은 POST 등)
- [ ] 적절한 상태 코드 반환 (모든 것에 200 사용하지 않음)
- [ ] 스키마로 입력 검증 (Zod, Pydantic, Bean Validation)
- [ ] 오류 응답이 코드와 메시지가 있는 표준 형식을 따름
- [ ] 목록 엔드포인트에 페이지네이션 구현 (커서 또는 오프셋)
- [ ] 인증 필요 (또는 명시적으로 공개로 표시)
- [ ] 인가 확인 (사용자는 자신의 리소스만 접근 가능)
- [ ] 요청 제한 설정
- [ ] 응답이 내부 세부 사항을 노출하지 않음 (스택 트레이스, SQL 오류)
- [ ] 기존 엔드포인트와 일관된 명명 (camelCase vs snake_case)
- [ ] 문서화 (OpenAPI/Swagger 스펙 업데이트)

More agent context in junimnjw/everything-claude-code

189 other files this repository gives its agents, the first 60 shown.