REST API设计最佳实践
REST API 설계
좋은 REST API를 설계하는 핵심 원칙을 다룹니다.
URI 설계
GET /api/users # 목록 조회
GET /api/users/:id # 단일 조회
POST /api/users # 생성
PUT /api/users/:id # 수정
DELETE /api/users/:id # 삭제
HTTP 상태 코드
| 코드 | 의미 |
|---|---|
| 200 | 성공 |
| 201 | 생성됨 |
| 400 | 잘못된 요청 |
| 401 | 인증 필요 |
| 404 | 찾을 수 없음 |
| 500 | 서버 오류 |
Express 구현 예시
const express = require('express');
const router = express.Router();
router.get('/users', (req, res) => {
const { page = 1, limit = 20 } = req.query;
const users = db.prepare('SELECT * FROM users LIMIT ? OFFSET ?')
.all(limit, (page - 1) * limit);
res.json({ data: users, page, limit });
});
API 설계는 프론트엔드와 백엔드의 계약서입니다.