엔드포인트 생성하기
엔드포인트란 무엇입니까?
| 구성 요소 | 설명 | 예시 |
|---|---|---|
| HTTP 메서드 | 수행할 작업 | GET, POST, PUT, DELETE |
| 경로 | 기본 URL을 기준으로 한 URL 경로 | /users/{id} |
| 매개변수 | 경로, 쿼리, 헤더 또는 본문 매개변수 | id(경로 매개변수) |
| 요청 본문 | 요청과 함께 전송되는 데이터(POST/PUT용) | JSON schema |
| 응답 | 예상 응답 형식 및 상태 코드 | 200 OK, 404 Not Found |
핵심 개념
엔드포인트 생성하기
사전 준비 사항
빠른 시작: 기본 엔드포인트 생성
1.
2.
엔드포인트 생성 방법
| 방법 | 사용 시점 | 단계 |
|---|---|---|
| 수동 생성 | 처음부터 시작하는 경우 | 1. 폴더를 마우스 오른쪽 버튼으로 클릭 → "New Endpoint" 2. 메서드와 경로 입력 3. 매개변수와 응답 정의 |
| 코드에서 가져오기 | 기존 API 코드가 있는 경우 | 1. "Import" 기능 사용 2. OpenAPI/Swagger 파일 업로드 3. 모듈에 매핑 |
| 요청에서 생성 | 기존 API를 테스트하는 경우 | 1. 먼저 요청 전송 2. "Save" 클릭 3. 명세 개선 |
| 기존 항목 복제 | 유사한 엔드포인트가 있는 경우 | 1. 엔드포인트를 마우스 오른쪽 버튼으로 클릭 → "Duplicate" 2. 경로와 매개변수 수정 |
엔드포인트 세부 정보 지정하기
기본 정보
매개변수
경로 매개변수
GET /users/{userId}/posts/{postId}| 매개변수 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
userId | integer | 예 | 고유 사용자 식별자 |
postId | integer | 예 | 게시물 식별자 |
쿼리 매개변수
| 매개변수 | 유형 | 필수 여부 | 기본값 | 설명 |
|---|---|---|---|---|
limit | integer | 아니요 | 10 | 반환할 결과 수 |
offset | integer | 아니요 | 0 | 건너뛸 결과 수 |
status | string | 아니요 | active | 상태별 필터링 |
요청 본문(POST/PUT용)
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "User's full name"
},
"email": {
"type": "string",
"format": "email",
"description": "User's email address"
}
},
"required": ["name", "email"]
}응답
성공 응답(200 OK)
{
"id": 123,
"name": "John Doe",
"email": "john@example.com",
"createdAt": "2023-01-15T10:30:00Z"
}오류 응답
| 상태 코드 | 설명 | 스키마 |
|---|---|---|
400 | Bad Request | 오류 세부 정보 |
401 | Unauthorized | 인증 오류 |
404 | Not Found | 리소스를 찾을 수 없음 |
500 | Internal Server Error | 서버 오류 세부 정보 |
Modified at 2026-06-09 08:53:32