TypeScript 실전 프로젝트 | REST API 서버 만들기
이 글의 핵심
mkdir typescript-api cd typescript-api.
들어가며
이 글에서는 TypeScript로 요청·응답 형태가 컴파일 타임에 맞는 REST API 서버를 한 바퀴 구성해 봅니다. Express와 타입 정의를 연결하는 흐름을 따라가시면 됩니다.
JavaScript에서 TypeScript로의 전환
“런타임 에러는 프로덕션에서 터진다”는 말이 있습니다. JavaScript로 개발하던 시절, 이 말을 뼈저리게 체감했습니다. 테스트는 다 통과했는데 배포 후 사용자가 이상한 데이터를 입력하면 앱이 터지는 거습니다. 특히 팀 프로젝트에서 다른 사람이 작성한 함수의 반환 타입을 잘못 이해해서 버그가 발생하는 일이 잦았습니다. TypeScript를 도입한 후 가장 먼저 느낀 건 안심이었습니다. IDE가 자동완성을 정확히 해주으며, 타입이 맞지 않으면 빨간 줄로 미리 알려줍니다. 리팩토링할 때도 “이 함수를 바꾸면 어디가 깨질까?” 걱정할 필요가 없어졌습니다. 물론 처음엔 타입 정의 작성이 번거로웠지만, 몇 달 후 그 타입 정의 덕분에 버그를 미리 잡는 경험을 하고 나니 돌아갈 수 없었습니다.
1. 프로젝트 설정
초기화
mkdir typescript-api
cd typescript-api
npm init -y
npm install express
npm install --save-dev typescript @types/node @types/express ts-node nodemontsconfig.json
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"lib": [ES2020],
"outDir": "./dist",
"rootDir": "./src",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"resolveJsonModule": true
},
"include": [src/**/*],
"exclude": ["node_modules", "dist"]
}package.json 스크립트
{
"scripts": {
"dev": "nodemon --exec ts-node src/index.ts",
"build": "tsc",
"start": "node dist/index.js"
}
}2. 타입 정의
src/types/user.ts
export interface User {
id: string;
name: string;
email: string;
age: number;
createdAt: Date;
}
export type CreateUserDto = Omit<User, "id" | "createdAt">;
export type UpdateUserDto = Partial<CreateUserDto>;
export type UserResponse = Omit<User, "createdAt"> & {
createdAt: string;
};src/types/api.ts
export interface ApiResponse<T> {
success: boolean;
data?: T;
error?: string;
}
export interface PaginatedResponse<T> {
items: T[];
total: number;
page: number;
pageSize: number;
}3. 데이터베이스 (메모리)
src/database/users.ts
import { User } from "../types/user";
class UserDatabase {
private users: Map<string, User> = new Map();
private currentId = 1;
create(data: Omit<User, "id" | "createdAt">): User {
const user: User = {
id: `U${String(this.currentId++).padStart(3, "0")}`,
...data,
createdAt: new Date()
};
this.users.set(user.id, user);
return user;
}
findAll(): User[] {
return Array.from(this.users.values());
}
findById(id: string): User | undefined {
return this.users.get(id);
}
update(id: string, data: Partial<User>): User | undefined {
const user = this.users.get(id);
if (!user) return undefined;
const updated = { ...user, ...data };
this.users.set(id, updated);
return updated;
}
delete(id: string): boolean {
return this.users.delete(id);
}
}
export const userDb = new UserDatabase();4. 서비스 레이어
src/services/userService.ts
import { userDb } from "../database/users";
import { CreateUserDto, UpdateUserDto, User } from "../types/user";
export class UserService {
async createUser(data: CreateUserDto): Promise<User> {
this.validateEmail(data.email);
this.validateAge(data.age);
return userDb.create(data);
}
async getUsers(): Promise<User[]> {
return userDb.findAll();
}
async getUserById(id: string): Promise<User | undefined> {
return userDb.findById(id);
}
async updateUser(id: string, data: UpdateUserDto): Promise<User | undefined> {
if (data.email) {
this.validateEmail(data.email);
}
if (data.age !== undefined) {
this.validateAge(data.age);
}
return userDb.update(id, data);
}
async deleteUser(id: string): Promise<boolean> {
return userDb.delete(id);
}
private validateEmail(email: string): void {
const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
if (!emailRegex.test(email)) {
throw new Error("올바른 이메일 형식이 아닙니다");
}
}
private validateAge(age: number): void {
if (age < 0 || age > 150) {
throw new Error("나이는 0-150 사이여야 합니다");
}
}
}
export const userService = new UserService();5. 컨트롤러
src/controllers/userController.ts
import { Request, Response } from "express";
import { userService } from "../services/userService";
import { ApiResponse } from "../types/api";
import { UserResponse } from "../types/user";
export class UserController {
async createUser(req: Request, res: Response): Promise<void> {
try {
const user = await userService.createUser(req.body);
const response: ApiResponse<UserResponse> = {
success: true,
data: {
...user,
createdAt: user.createdAt.toISOString()
}
};
res.status(201).json(response);
} catch (error) {
const response: ApiResponse<never> = {
success: false,
error: error instanceof Error ? error.message : "알 수 없는 에러"
};
res.status(400).json(response);
}
}
async getUsers(req: Request, res: Response): Promise<void> {
try {
const users = await userService.getUsers();
const response: ApiResponse<UserResponse[]> = {
success: true,
data: users.map(user => ({
...user,
createdAt: user.createdAt.toISOString()
}))
};
res.json(response);
} catch (error) {
const response: ApiResponse<never> = {
success: false,
error: error instanceof Error ? error.message : "알 수 없는 에러"
};
res.status(500).json(response);
}
}
async getUserById(req: Request, res: Response): Promise<void> {
try {
const user = await userService.getUserById(req.params.id);
if (!user) {
const response: ApiResponse<never> = {
success: false,
error: "사용자를 찾을 수 없습니다"
};
res.status(404).json(response);
return;
}
const response: ApiResponse<UserResponse> = {
success: true,
data: {
...user,
createdAt: user.createdAt.toISOString()
}
};
res.json(response);
} catch (error) {
const response: ApiResponse<never> = {
success: false,
error: error instanceof Error ? error.message : "알 수 없는 에러"
};
res.status(500).json(response);
}
}
async updateUser(req: Request, res: Response): Promise<void> {
try {
const user = await userService.updateUser(req.params.id, req.body);
if (!user) {
const response: ApiResponse<never> = {
success: false,
error: "사용자를 찾을 수 없습니다"
};
res.status(404).json(response);
return;
}
const response: ApiResponse<UserResponse> = {
success: true,
data: {
...user,
createdAt: user.createdAt.toISOString()
}
};
res.json(response);
} catch (error) {
const response: ApiResponse<never> = {
success: false,
error: error instanceof Error ? error.message : "알 수 없는 에러"
};
res.status(400).json(response);
}
}
async deleteUser(req: Request, res: Response): Promise<void> {
try {
const deleted = await userService.deleteUser(req.params.id);
if (!deleted) {
const response: ApiResponse<never> = {
success: false,
error: "사용자를 찾을 수 없습니다"
};
res.status(404).json(response);
return;
}
const response: ApiResponse<{ message: string }> = {
success: true,
data: { message: "사용자가 삭제되었습니다" }
};
res.json(response);
} catch (error) {
const response: ApiResponse<never> = {
success: false,
error: error instanceof Error ? error.message : "알 수 없는 에러"
};
res.status(500).json(response);
}
}
}
export const userController = new UserController();6. 라우터
src/routes/userRoutes.ts
import { Router } from "express";
import { userController } from "../controllers/userController";
const router = Router();
router.post("/", (req, res) => userController.createUser(req, res));
router.get("/", (req, res) => userController.getUsers(req, res));
router.get("/:id", (req, res) => userController.getUserById(req, res));
router.put("/:id", (req, res) => userController.updateUser(req, res));
router.delete("/:id", (req, res) => userController.deleteUser(req, res));
export default router;7. 메인 서버
src/index.ts
import express from "express";
import userRoutes from "./routes/userRoutes";
const app = express();
const PORT = 3000;
app.use(express.json());
app.use("/api/users", userRoutes);
app.get("/", (req, res) => {
res.json({ message: "TypeScript API 서버" });
});
app.listen(PORT, () => {
console.log(`서버 실행 중: http://localhost:${PORT}`);
});8. 테스트
서버 실행
npm run devAPI 테스트
# 사용자 생성
curl -X POST http://localhost:3000/api/users \
-H "Content-Type: application/json" \
-d '{"name":"홍길동","email":"hong@test.com","age":25}'
# 사용자 목록
curl http://localhost:3000/api/users
# 사용자 조회
curl http://localhost:3000/api/users/U001
# 사용자 수정
curl -X PUT http://localhost:3000/api/users/U001 \
-H "Content-Type: application/json" \
-d '{"name":"김철수"}'
# 사용자 삭제
curl -X DELETE http://localhost:3000/api/users/U001정리
핵심 요약
- 타입 정의: interface, type alias
- 레이어 분리: Controller, Service, Database
- 타입 안전성: 컴파일 타임 에러 검출
- 에러 처리: try-catch, ApiResponse
- 프로덕션: tsc 컴파일 후 배포
다음 단계
- TypeScript + MongoDB
- TypeScript + Prisma
- TypeScript 테스트
관련 글
- TypeScript 시작하기 | 설치, 설정, 기본 문법
- TypeScript 고급 타입 | Union, Intersection, Literal 타입
- TypeScript 인터페이스 | Interface 완벽 가이드
자주 묻는 질문 (FAQ)
Q. 이 내용을 실무에서 언제 쓰나요?
A. TypeScript 실전 프로젝트 mkdir typescript-api cd typescript-api. TypeScript·프로젝트·REST API 중심으로 설명합니다. Start now. 실무에서는 위 본문의 예제와 선택 가이드를 참고해 적용하면 됩니다.
Q. 선행으로 읽으면 좋은 글은?
A. 각 글 하단의 이전 글 또는 관련 글 링크를 따라가면 순서대로 배울 수 있습니다. C++ 시리즈 목차에서 전체 흐름을 확인할 수 있습니다.
Q. 더 깊이 공부하려면?
A. cppreference와 해당 라이브러리 공식 문서를 참고하세요. 글 말미의 참고 자료 링크도 활용하면 좋습니다.
같이 보면 좋은 글 (내부 링크)
이 주제와 연결되는 다른 글입니다.
- TypeScript 고급 패턴 | 조건부 타입, 템플릿 리터럴 타입
- JavaScript 모듈 | ES6 Modules, CommonJS 완벽 정리
- TypeScript REST API Project | Express· Layered Architecture
이 글에서 다루는 키워드 (관련 검색어)
TypeScript, 프로젝트, REST API, Express, Node.js 등으로 검색하시면 이 글이 도움이 됩니다.