경로와 요청 처리
API 경로를 정의하고 다양한 HTTP 메서드를 처리하며 요청 본문, 매개변수, 쿼리에서 데이터를 추출합니다.
경로와 요청 처리은(는) CoddyKit의 무료 NestJS Enterprise Backend APIs 강의입니다. 이것은 3개 중 1번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 NestJS Enterprise Backend APIs 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. NestJS Enterprise Backend APIs 강의에는 총 3개의 강의가 포함되어 있습니다.
이 강의의 일부는 아직 번역되지 않았으며 영어로 표시됩니다.
Understanding API Routes
When you build a web API, you need a way for clients (like a browser or mobile app) to send requests to specific functions on your server. This is where routes come in!
A route defines how a client's request URL (like /users or /products/1) maps to a particular action in your application code. It's like a street address for your API's functionalities.
HTTP Methods: The Action Verbs
Besides the URL, every request also uses an HTTP method, which tells the server what kind of action the client wants to perform. Common methods include:
- GET: Retrieve data (e.g., get a list of users).
- POST: Create new data (e.g., create a new user).
- PUT: Update existing data completely.
- PATCH: Partially update existing data.
- DELETE: Remove data.
NestJS uses decorators like @Get() or @Post() to link these methods to your controller functions.
Your First GET Route
Let's define a simple route to fetch some data. In NestJS, you use controllers to handle incoming requests and define routes.
The @Controller() decorator defines a base path for all routes within that controller. Then, methods like @Get() define specific endpoints and their HTTP methods.
Simple GET Route Example
Here's a basic NestJS app with a /greet endpoint. Run this example, then try accessing http://localhost:3000/greet in your browser or a tool like Postman.
You should see: Hello from NestJS!
// main.ts - Minimal NestJS app setup
import { NestFactory } from '@nestjs/core';
import { Module, Controller, Get } from '@nestjs/common';
@Controller('greet')
class GreetController {
@Get()
getGreeting(): string {
return 'Hello from NestJS!';
}
}
@Module({
controllers: [GreetController],
})
class AppModule {}
async function bootstrap() {
const app = await NestFactory.create(AppModule);
await app.listen(3000);
console.log('Server running on http://localhost:3000');
}
bootstrap();Dynamic Routes with Parameters
Often, you need routes that include dynamic data, like fetching a specific user by their ID (e.g., /users/123). These are called path parameters.
In NestJS, you define path parameters using a colon (:) followed by the parameter name in your @Get() decorator (e.g., @Get(':id')). You then extract its value using the @Param() decorator in your method signature.
Path Parameters Example
This example shows how to get a user ID from the URL path. If you run this, then visit http://localhost:3000/users/123, the output will be:
User ID: 123// main.ts - Minimal NestJS app setup
import { NestFactory } from '@nestjs/core';
import { Module, Controller, Get, Param } from '@nestjs/common';
@Controller('users')
class UsersController {
@Get(':id')
findUser(@Param('id') id: string): string {
return `User ID: ${id}`;
}
}
@Module({
controllers: [UsersController],
})
class AppModule {}
async function bootstrap() {
const app = await NestFactory.create(AppModule);
await app.listen(3000);
console.log('Server running on http://localhost:3000');
}
bootstrap();Filtering with Query Parameters
Query parameters are another way to pass data to your routes, often used for optional filtering, sorting, or pagination (e.g., /items?category=books&limit=5).
These parameters appear after a question mark (?) in the URL, as key-value pairs separated by ampersands (&). NestJS lets you easily access them using the @Query() decorator.
Query Parameters Example
This route uses query parameters to filter items. If you run this, then visit http://localhost:3000/items?category=books&limit=5, you'll see:
Category: books, Limit: 5// main.ts - Minimal NestJS app setup
import { NestFactory } from '@nestjs/core';
import { Module, Controller, Get, Query } from '@nestjs/common';
@Controller('items')
class ItemsController {
@Get()
findItems(
@Query('category') category: string,
@Query('limit') limit: string,
): string {
return `Category: ${category || 'all'}, Limit: ${limit || '10'}`;
}
}
@Module({
controllers: [ItemsController],
})
class AppModule {}
async function bootstrap() {
const app = await NestFactory.create(AppModule);
await app.listen(3000);
console.log('Server running on http://localhost:3000');
}
bootstrap();Handling Request Body (POST/PUT)
For operations that send a lot of data, like creating a new resource (POST) or updating an existing one (PUT), the data is typically sent in the request body.
The request body can contain structured data, often JSON. NestJS provides the @Body() decorator to easily parse and extract this data directly into your controller method's arguments.
Request Body Example (POST)
This example shows how to accept data in the request body for a POST request. If you send a POST request to http://localhost:3000/products with a JSON body like {"name": "Laptop", "price": 1200}, the output will be:
Product created: {"name":"Laptop","price":1200}// main.ts - Minimal NestJS app setup
import { NestFactory } from '@nestjs/core';
import { Module, Controller, Post, Body } from '@nestjs/common';
interface Product {
name: string;
price: number;
}
@Controller('products')
class ProductsController {
@Post()
createProduct(@Body() product: Product): string {
return `Product created: ${JSON.stringify(product)}`;
}
}
@Module({
controllers: [ProductsController],
})
class AppModule {}
async function bootstrap() {
const app = await NestFactory.create(AppModule);
await app.listen(3000);
console.log('Server running on http://localhost:3000');
}
bootstrap();Route Handling Check
Consider the following NestJS controller snippet:
import { Controller, Get, Param, Query } from '@nestjs/common';
@Controller('articles')
class ArticlesController {
@Get(':id')
getArticleById(@Param('id') id: string): string {
return `Article ID: ${id}`;
}
@Get()
searchArticles(@Query('keyword') keyword: string): string {
return `Searching for: ${keyword || 'all articles'}`;
}
}Which URL would successfully retrieve an article with ID "123"?
Recap: Routes & Requests
Great job! You've covered the fundamentals of defining API routes and handling different types of incoming data in NestJS:
- Routes map URLs to controller actions.
- HTTP methods (GET, POST, PUT, DELETE) define the action type.
- Path parameters (
@Param()) capture dynamic segments from the URL path. - Query parameters (
@Query()) extract optional key-value pairs from the URL string. - Request body (
@Body()) handles data sent with POST/PUT requests.
These are crucial building blocks for any robust RESTful API!
자주 묻는 질문
“경로와 요청 처리” 강의는 무료인가요?
네 — “경로와 요청 처리” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 NestJS Enterprise Backend APIs 강의 전체를 잠금 해제할 수 있습니다. NestJS Enterprise Backend APIs 강의에는 총 3개의 강의가 포함되어 있습니다.
“경로와 요청 처리”에서 뭘 배우나요?
API 경로를 정의하고 다양한 HTTP 메서드를 처리하며 요청 본문, 매개변수, 쿼리에서 데이터를 추출합니다. 브라우저에서 직접 실행하는 실습 코드로 NestJS Enterprise Backend APIs을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
NestJS Enterprise Backend APIs을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 NestJS Enterprise Backend APIs은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 3개 중 1번째 강의입니다.
“경로와 요청 처리” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 NestJS Enterprise Backend APIs 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 NestJS Enterprise Backend APIs 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.
이 강의의 모든 강의
- 경로와 요청 처리
- TypeORM을 사용한 CRUD 작업
- 오류 처리와 인터셉터