api-design

name	api-design
description	리소스 명명, 상태 코드, 페이지네이션, 필터링, 에러 응답, 버전 관리 및 프로덕션 API를 위한 전송률 제한을 포함한 REST API 설계 패턴.
metadata	{"origin":"ECC"}

API 설계 패턴 (API Design Patterns)

일관성 있고 개발자 친화적인 REST API 설계를 위한 컨벤션 및 모범 사례입니다.

활성화 시기

• 새로운 API 엔드포인트 설계 시
• 기존 API 규격(Contract) 검토 시
• 페이지네이션, 필터링 또는 정렬 기능 추가 시
• API를 위한 에러 처리 구현 시
• API 버전 관리 전략 수립 시
• 공개용 또는 파트너용 API 구축 시

리소스 설계

URL 구조

# 리소스는 명사, 복수형, 소문자, 케밥 케이스(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

# 관계를 나타내는 하위 리소스
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# CRUD로 매핑되지 않는 동작 (동사는 아껴서 사용하세요)
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh

명명 규칙

# 좋음 (GOOD)
/api/v1/team-members          # 여러 단어로 된 리소스는 케밥 케이스 사용
/api/v1/orders?status=active  # 필터링을 위한 쿼리 파라미터
/api/v1/users/123/orders      # 소유 관계를 위한 중첩 리소스

# 나쁨 (BAD)
/api/v1/getUsers              # URL에 동사 포함
/api/v1/user                  # 단수형 (복수형 권장)
/api/v1/team_members          # URL에 스네이크 케이스 사용
/api/v1/users/123/getOrders   # 중첩 리소스에 동사 포함

HTTP 메서드 및 상태 코드

메서드 의미론 (Semantics)

메서드	멱등성(Idempotent)	안전성(Safe)	용도
GET	예	예	리소스 조회
POST	아니요	아니요	리소스 생성, 동작 트리거
PUT	예	아니요	리소스 전체 교체
PATCH	아니요*	아니요	리소스 부분 업데이트
DELETE	예	아니요	리소스 삭제

*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 헤더 포함 권장

흔한 실수

# 나쁨: 모든 요청에 200 반환
{ "status": 200, "success": false, "error": "찾을 수 없음" }

# 좋음: HTTP 상태 코드를 의미에 맞게 사용
HTTP/1.1 404 Not Found
{ "error": { "code": "not_found", "message": "사용자를 찾을 수 없습니다." } }

# 나쁨: 검증 에러에 500 사용
# 좋음: 필드 레벨의 상세 정보와 함께 400 또는 422 사용

# 나쁨: 리소스 생성 시 200 사용
# 좋음: Location 헤더와 함께 201 사용
HTTP/1.1 201 Created
Location: /api/v1/users/abc-123

응답 형식

성공 응답

{
  "data": {
    "id": "abc-123",
    "email": "[e-mail]",
    "name": "Alice",
    "created_at": "2025-01-15T10:30:00Z"
  }
}

목록 응답 (페이지네이션 포함)

{
  "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"
  

에러 응답

{
  "error": {
    "code": "validation_error",
    "message": "요청 검증에 실패했습니다.",
    "details": [
      {
        "field": "email",
        "message": "유효한 이메일 주소여야 합니다.",
        "code": "invalid_format"
      },
      {
        "field": "age",
        "message": "0에서 150 사이여야 합니다.",
        "code": "out_of_range"
      }
    ]
  }
}

응답 봉투(Envelope) 변형

// 옵션 A: 데이터 래퍼를 포함한 봉투 방식 (공개 API에 권장)
interface ApiResponse<T> {
  data: T;
  meta?: PaginationMeta;
  links?: PaginationLinks;
}

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

// 옵션 B: 평면(Flat) 응답 방식 (내부 API에 흔히 쓰이는 간단한 방식)
// 성공 시: 리소스를 직접 반환
// 에러 시: 에러 객체 반환
// HTTP 상태 코드로 구분

페이지네이션 (Pagination)

오프셋 기반 (Offset-Based) (단순 방식)

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

# 구현 예시
SELECT * FROM users
ORDER BY created_at DESC
LIMIT 20 OFFSET 20;

장점: 구현이 쉽고 "N페이지로 이동" 기능을 지원함 단점: 오프셋이 커질수록(예: OFFSET 100000) 속도가 느려지며, 동시에 데이터가 삽입될 경우 중복 누락 가능성이 있음

커서 기반 (Cursor-Based) (확장 가능한 방식)

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

# 구현 예시
SELECT * FROM users
WHERE id > :cursor_id
ORDER BY id ASC
LIMIT 21;  -- 다음 페이지 존재 여부 확인을 위해 하나 더 조회

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

장점: 위치에 상관없이 일관된 성능을 보이며, 실시간 데이터 삽입에도 안정적임 단점: 임의의 페이지로 바로 건너뛸 수 없으며, 커서 값이 불투명함

사용 시점 선택 기준

사용 사례	페이지네이션 유형
관리자 대시보드, 소규모 데이터셋 (<1만 건)	오프셋(Offset)
무한 스크롤, 피드, 대규모 데이터셋	커서(Cursor)
공개용 API	커서(Cursor)를 기본으로 하고 오프셋은 선택적 제공
검색 결과	오프셋(Offset) (사용자가 페이지 번호를 기대함)

필터링, 정렬 및 검색

필터링

# 단순 등치 비교
GET /api/v1/orders?status=active&customer_id=abc-123

# 비교 연산자 (대괄호 표기법 사용 권장)
GET /api/v1/products?price[gte]=10&price[lte]=100
GET /api/v1/orders?created_at[after]=2025-01-01

# 여러 값 (쉼표로 구분)
GET /api/v1/products?category=electronics,clothing

# 중첩 필드 (점 표기법 사용)
GET /api/v1/orders?customer.country=US

정렬

# 단일 필드 (내림차순은 접두사 - 사용)
GET /api/v1/products?sort=-created_at

# 여러 필드 (쉼표로 구분)
GET /api/v1/products?sort=-featured,price,-created_at

전체 텍스트 검색

# 검색 쿼리 파라미터
GET /api/v1/products?q=무선+헤드폰

# 필드별 검색
GET /api/v1/users?email=alice

희소 필드셋 (Sparse Fieldsets)

# 필요한 필드만 지정하여 응답 크기 줄이기
GET /api/v1/users?fields=id,name,email
GET /api/v1/orders?fields=id,total,status&include=customer.name

인증 및 인가

토큰 기반 인증

# Authorization 헤더에 Bearer 토큰 포함
GET /api/v1/users
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

# API 키 (서버 간 통신용)
GET /api/v1/data
X-API-Key: sk_live_abc123

인가 패턴

// 리소스 레벨: 소유권 확인
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 });
});

// 역할 기반: 권한 확인
app.delete("/api/v1/users/:id", requireRole("admin"), async (req, res) => {
  await User.delete(req.params.id);
  return res.status(204).send();
});

전송률 제한 (Rate Limiting)

헤더 정보

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

# 제한 초과 시
HTTP/1.1 429 Too Many Requests
Retry-After: 60
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "전송률 제한을 초과했습니다. 60초 후에 다시 시도하세요."
  }
}

전송률 제한 등급 (Tiers)

등급	제한	창(Window)	사용 사례
익명	30회/분	IP당	공개 엔드포인트
인증됨	100회/분	사용자당	표준 API 접근
프리미엄	1,000회/분	API 키당	유료 API 플랜
내부	10,000회/분	서비스당	서비스 간 통신

버전 관리 (Versioning)

URL 경로 버전 관리 (권장)

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

장점: 명시적이고 라우팅이 쉬우며 캐싱이 가능함 단점: 버전 간에 URL이 변경됨

헤더 버전 관리

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

장점: URL이 깔끔하게 유지됨 단점: 테스트하기 어렵고 설정하는 것을 잊기 쉬움

버전 관리 전략

1. /api/v1/으로 시작하세요 — 꼭 필요할 때까지는 버전을 올리지 마세요.
2. 최대 2개의 활성 버전(현재 버전 + 이전 버전)만 유지하세요.
3. 지원 중단(Deprecation) 타임라인:
   - 지원 중단 공지 (공개 API의 경우 최소 6개월 전)
   - Sunset 헤더 추가: Sunset: Sat, 01 Jan 2026 00:00:00 GMT
   - Sunset 날짜 이후에는 410 Gone 반환
4. 하위 호환되는 변경은 새 버전이 필요하지 않습니다:
   - 응답에 새로운 필드 추가
   - 새로운 선택적 쿼리 파라미터 추가
   - 새로운 엔드포인트 추가
5. 하위 호환되지 않는 변경은 새 버전이 필요합니다:
   - 필드 제거 또는 이름 변경
   - 필드 타입 변경
   - URL 구조 변경
   - 인증 방식 변경

구현 패턴

TypeScript (Next.js API 라우트)

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: "요청 검증에 실패했습니다.",
        details: parsed.error.issues.map(i => ({
          field: i.path.join("."),
          message: i.message,
          : i.,
        })),
      },
    }, { :  });
  }

   user =  (parsed.);

   .(
    { : user },
    {
      : ,
      : { :  },
    },
  );
}

Python (Django REST Framework)

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)

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", "잘못된 요청 바디")
        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", "이미 등록된 이메일입니다.")
        default:
            writeError(w, http.StatusInternalServerError, "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이 명명 규칙을 따름 (복수형, 케밥 케이스, 동사 미포함)
• 올바른 HTTP 메서드 사용 (조회는 GET, 생성은 POST 등)
• 적절한 상태 코드 반환 (모든 요청에 200 반환 금지)
• 스키마를 통한 입력값 검증 완료 (Zod, Pydantic, Bean Validation 등)
• 에러 응답이 코드와 메시지를 포함한 표준 형식을 따름
• 목록 엔드포인트에 페이지네이션 구현 (커서 또는 오프셋)
• 인증 필수 (또는 명시적으로 공개 설정됨)
• 인가 확인 (사용자가 자신의 리소스에만 접근 가능한지)
• 전송률 제한 구성 완료
• 응답에 내부 세부 정보(스택 추적, SQL 오류 등)가 누출되지 않음
• 기존 엔드포인트와 일관된 명명법 사용 (camelCase vs snake_case)
• 문서화 완료 (OpenAPI/Swagger 사양 업데이트)