API 디자인

블로그 API의 엔드포인트를 설계해줘.

리소스:
- 사용자 (users)
- 게시물 (posts)
- 댓글 (comments)
- 카테고리 (categories)

요구:
- CRUD 엔드포인트
- 페이지네이션
- 필터링
- 정렬

RESTful 명명 규칙을 적용한 엔드포인트를 작성해줘:

리소스: orders (주문)

기본 CRUD:
- GET    /orders          # 전체 조회
- GET    /orders/:id      # 단일 조회
- POST   /orders          # 생성
- PUT    /orders/:id      # 전체 수정
- PATCH  /orders/:id      # 부분 수정
- DELETE /orders/:id      # 삭제

특정 행동:
- POST   /orders/:id/cancel    # 주문 취소
- POST   /orders/:id/refund   # 환불 요청

관계 리소스:
- GET /orders/:id/items        # 주문 상품 목록
- GET /users/:id/orders        # 사용자의 주문 목록

쿼리 파라미터 표준을 설계해줘:

페이지네이션:
- page: 페이지 번호 (기본값 1)
- limit: 페이지당 항목 수 (기본값 20, 최대 100)
- 예: /posts?page=2&limit=10

필터링:
- 필드명=값 형식
- 여러 필터: &로 연결
- 예: /posts?status=published&author_id=1

정렬:
- sort: 필드명
- order: asc | desc
- 예: /posts?sort=created_at&order=desc

검색:
- q: 검색어
- 예: /posts?q=안녕하세요

API 응답 형식을 표준화해줘.

성공 응답:
- success: boolean
- data: object
- message: string (선택)
- pagination: object (선택)

에러 응답:
- success: false
- error: object
  - code: string
  - message: string
  - details: object (선택)

{
  "success": true,
  "data": {
    "id": 1,
    "title": "첫 번째 게시물",
    "content": "내용...",
    "author": {
      "id": 1,
      "name": "홍길동"
    },
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

{
  "success": true,
  "data": [
    { "id": 1, "title": "게시물 1" },
    { "id": 2, "title": "게시물 2" }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "입력 데이터가 유효하지 않습니다",
    "details": [
      { "field": "email", "message": "올바른 이메일을 입력해주세요" },
      { "field": "password", "message": "비밀번호는 8자 이상이어야 합니다" }
    ]
  }
}

사용자 생성 API의 요청 스키마를 작성해줘:

요구사항:
- email: 필수, 유효한 이메일 형식
- password: 필수, 8~20자, 영문+숫자+특수문자
- name: 필수, 2~50자
- age: 선택, 1~150 사이의 숫자
- role: 선택, 기본값 'user', enum ['user', 'admin']

도구: Zod 스키마로

API 에러 코드 시스템을 설계해줘:

카테고리:
- AUTH_*: 인증/인가 관련
- VALIDATION_*: 유효성 검사
- RESOURCE_*: 리소스 관련
- INTERNAL_*: 서버 내부

예시:
- AUTH_TOKEN_EXPIRED
- AUTH_INVALID_CREDENTIALS
- VALIDATION_EMAIL_INVALID
- RESOURCE_NOT_FOUND
- RESOURCE_ALREADY_EXISTS

API 버전 관리 전략을 설계해줘.

요구사항:
1. URL 기반 버전 (v1, v2)
2. 호환성이 깨진 변경은 새 버전에서
3.이전 버전은 최소 6개월 지원
4. deprecation 알림 헤더

Deprecation: true
Link: <https://api.example.com/v2/users>; rel="successor-version"
Sunset: Sat, 01 Jun 2024 00:00:00 GMT

OpenAPI (Swagger) 문서를 생성해줘.

포함 내용:
- 모든 엔드포인트 설명
- 요청/응답 스키마
- 에러 응답 예시
- 인증 요구사항

OpenAPI 3.0 스키마를 작성해줘:

엔드포인트: POST /api/users
요청:
- email: string, required, format email
- password: string, required, minLength 8
- name: string, required

응답:
- 201: user object
- 400: validation error
- 409: duplicate email error

스키마:
- components/schemas/User
- components/schemas/Error
- components/securitySchemes/BearerAuth

JWT 인증 시스템을 설계해줘:

요구사항:
- Access Token: 15분 유효
- Refresh Token: 7일 유효
- 저장소: httpOnly Cookie
- 보안: httpOnly, secure, sameSite
- 갱신 엔드포인트 포함

환경: Express.js + TypeScript

const express = require('express');
const cors = require('cors');

const app = express();

// 개발 환경에서만 사용!
app.use(cors());

const corsOptions = {
  origin: [
    'https://myapp.com',
    'https://www.myapp.com',
    'https://admin.myapp.com'
  ],
  methods: ['GET', 'POST', 'PUT', 'DELETE'],
  credentials: true,  // 쿠키 포함 허용
  maxAge: 86400      // preflight 캐시 시간 (24시간)
};

app.use(cors(corsOptions));

const allowedOrigins = process.env.NODE_ENV === 'production'
  ? ['https://myapp.com', 'https://www.myapp.com']
  : ['http://localhost:3000', 'http://localhost:5173'];

const corsOptions = {
  origin: (origin, callback) => {
    // origin이 없는 경우 허용 (같은 도메인 요청, Postman 등)
    if (!origin || allowedOrigins.includes(origin)) {
      callback(null, true);
    } else {
      callback(new Error('Not allowed by CORS'));
    }
  },
  credentials: true
};

app.use(cors(corsOptions));

NODE_ENV=production
ALLOWED_ORIGINS=https://myapp.com,https://www.myapp.com

const allowedOrigins = process.env.ALLOWED_ORIGINS
  ? process.env.ALLOWED_ORIGINS.split(',')
  : ['http://localhost:3000'];

const corsOptions = {
  origin: allowedOrigins,
  credentials: true
};

app.use(cors(corsOptions));

# Preflight 요청 테스트
curl -X OPTIONS http://localhost:3000/api/users \
  -H "Origin: https://myapp.com" \
  -H "Access-Control-Request-Method: POST" \
  -v

# 실제 요청 테스트
curl -X GET http://localhost:3000/api/users \
  -H "Origin: https://myapp.com" \
  -v

Rate Limiting 전략을 설계해줘:

요구사항:
- 일반 사용자: 100 req/min
- 프리미엄 사용자: 1000 req/min
- 특정 엔드포인트: 별도 제한
- Rate Limit 헤더 포함

헤더:
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Reset

환경: Express.js

캐싱 전략을 설계해줘:

시나리오:
- 사용자 프로필: 5분 캐시
- 상품 목록: 1분 캐시
- 실시간 재고: 캐시 안 함
- 인기 검색어: 10분 캐시

요구사항:
- Redis 사용
- Cache-Control 헤더
- Invalidation 전략