BoxLang에서 RESTful API 만들기 – 실습 중심 강의 (17강)

BoxLang에서 RESTful API 만들기 – 실습 중심 강의

오늘은 **BoxLang**을 사용하여 **RESTful API**를 만드는 방법에 대해 실습 중심으로 배워보겠습니다. **RESTful API**는 웹 애플리케이션에서 서버와 클라이언트 간의 데이터를 주고받기 위한 주요 방식으로, **HTTP 프로토콜**을 기반으로 동작합니다. 이번 강의에서는 **BoxLang**을 이용해 간단한 **RESTful API**를 구축하고, **HTTP 요청**을 처리하는 방법을 배워볼 것입니다.

RESTful API란?

**RESTful API**는 **Representational State Transfer (REST)**의 원칙을 따르는 API입니다. REST는 HTTP 프로토콜을 기반으로 클라이언트와 서버 간의 데이터를 주고받는 방식으로, **리소스**(Resource)라는 개념을 중심으로 설계됩니다. 이 리소스들은 **URL**을 통해 접근하며, HTTP 메서드(GET, POST, PUT, DELETE 등)를 통해 CRUD(생성, 조회, 수정, 삭제) 작업을 수행합니다.

**RESTful API**는 데이터의 상태를 표현하는 방식으로 **JSON**을 주로 사용하며, 이를 통해 클라이언트와 서버 간의 효율적인 데이터 교환이 가능합니다. **BoxLang**에서는 이러한 API를 손쉽게 구축할 수 있는 기능을 제공합니다.

1. BoxLang에서 RESTful API 구축하기

**BoxLang**에서는 **HTTP 요청**을 처리하고, **RESTful API**를 쉽게 만들 수 있도록 도와주는 기능들이 내장되어 있습니다. 여기서는 간단한 **GET** 및 **POST** 요청을 처리하는 API를 만들어보겠습니다.

1.1 BoxLang 웹 서버 시작하기

먼저 BoxLang에서 웹 서버를 시작해야 합니다. BoxLang은 기본적으로 내장 HTTP 서버를 제공하므로, 이를 활용하여 API 서버를 구축할 수 있습니다. 아래는 기본적인 웹 서버를 시작하는 코드입니다.

import BoxLang.Web.Server

// 웹 서버 시작
func startServer() {
    var server = WebServer.create(8080) // 8080 포트에서 서버 시작
    server.start()
    println("서버가 8080 포트에서 실행 중입니다.")
}

startServer()

위 코드는 8080 포트에서 웹 서버를 실행하는 간단한 예시입니다. 웹 서버가 실행되면, 클라이언트가 8080 포트로 요청을 보낼 수 있습니다.

1.2 RESTful API의 GET 요청 처리하기

**GET** 요청은 서버에서 데이터를 조회할 때 사용됩니다. 아래는 `GET /api/users` 엔드포인트로 사용자 데이터를 조회하는 API를 만드는 예시입니다.

import BoxLang.Web.Server

// 사용자 데이터
var users = [
    {"id": 1, "name": "John Doe", "age": 30},
    {"id": 2, "name": "Jane Smith", "age": 25}
]

// GET 요청 처리
func getUsers(request: WebRequest, response: WebResponse) {
    var jsonResponse = Json.stringify(users) // 사용자 데이터를 JSON 형식으로 변환
    response.send(jsonResponse, 200) // HTTP 상태 코드 200(성공)과 함께 JSON 데이터 반환
}

// 웹 서버에 GET 엔드포인트 등록
func startServer() {
    var server = WebServer.create(8080)
    server.get("/api/users", getUsers)  // /api/users 경로에 대한 GET 요청 처리
    server.start()
    println("서버가 8080 포트에서 실행 중입니다.")
}

startServer()

위 코드는 `/api/users` 경로에 **GET** 요청이 들어오면, 사용자 목록을 **JSON** 형식으로 반환하는 예시입니다. 클라이언트가 `/api/users`로 요청을 보내면, 서버는 `users` 데이터를 JSON 형식으로 응답합니다.

1.3 RESTful API의 POST 요청 처리하기

**POST** 요청은 서버에 데이터를 전송하여 새로운 리소스를 생성할 때 사용됩니다. 아래는 `POST /api/users` 엔드포인트로 사용자 데이터를 추가하는 API를 만드는 예시입니다.

import BoxLang.Web.Server

// 사용자 데이터
var users = [
    {"id": 1, "name": "John Doe", "age": 30},
    {"id": 2, "name": "Jane Smith", "age": 25}
]

// POST 요청 처리
func createUser(request: WebRequest, response: WebResponse) {
    var userData = request.body // 요청 본문에서 데이터 가져오기
    var newUser = Json.parse(userData) // JSON 데이터를 파싱하여 객체로 변환
    
    // 사용자 데이터 추가
    users.append(newUser)
    response.send("사용자 추가 성공!", 201) // HTTP 상태 코드 201(생성됨) 반환
}

// 웹 서버에 POST 엔드포인트 등록
func startServer() {
    var server = WebServer.create(8080)
    server.post("/api/users", createUser)  // /api/users 경로에 대한 POST 요청 처리
    server.start()
    println("서버가 8080 포트에서 실행 중입니다.")
}

startServer()

위 코드는 `/api/users` 경로에 **POST** 요청을 보내면, 요청 본문에 포함된 사용자 데이터를 **JSON** 형식으로 파싱하여 `users` 목록에 추가하는 예시입니다. 성공적으로 데이터가 추가되면 "사용자 추가 성공!" 메시지를 반환합니다.

2. RESTful API 테스트하기

이제 간단한 **GET** 및 **POST** 요청을 처리하는 API를 만들었으니, 이를 실제로 테스트할 차례입니다. **POSTMAN**이나 **curl**과 같은 도구를 사용하여 API를 테스트할 수 있습니다.

- **GET 요청**: `/api/users` 경로로 GET 요청을 보내면, 사용자 목록이 JSON 형식으로 반환됩니다. - **POST 요청**: `/api/users` 경로로 POST 요청을 보내고, 요청 본문에 새로운 사용자 데이터를 포함시키면, 사용자 목록에 새로운 데이터가 추가됩니다.

3. RESTful API에서 오류 처리하기

**RESTful API**에서는 클라이언트가 잘못된 요청을 보낼 수 있습니다. 이럴 때는 적절한 HTTP 상태 코드와 오류 메시지를 반환하는 것이 중요합니다. BoxLang에서는 `response.send`를 사용하여 오류 메시지를 반환할 수 있습니다.

import BoxLang.Web.Server

// 오류 처리 예시
func createUser(request: WebRequest, response: WebResponse) {
    var userData = request.body
    if (userData.isEmpty()) {
        response.send("사용자 데이터가 없습니다.", 400) // 잘못된 요청에는 400번 상태 코드
        return
    }
    
    var newUser = Json.parse(userData)
    users.append(newUser)
    response.send("사용자 추가 성공!", 201)
}

// POST 요청 처리에서 오류 응답 예시
func startServer() {
    var server = WebServer.create(8080)
    server.post("/api/users", createUser)
    server.start()
    println("서버가 8080 포트에서 실행 중입니다.")
}

startServer()

위 코드는 **POST** 요청에서 데이터가 없을 경우, **400 Bad Request** 상태 코드와 함께 오류 메시지를 반환하는 예시입니다. 이를 통해 클라이언트에게 적절한 오류를 전달할 수 있습니다.

마무리 및 다음 강의 예고

이번 강의에서는 **BoxLang**을 사용하여 **RESTful API**를 구축하는 방법을 배웠습니다. **GET** 및 **POST** 요청을 처리하는 API를 실습하며, **HTTP 요청**을 처리하는 기본적인 방법과 **JSON** 형식으로 데이터를 주고받는 방법을 익혔습니다. 또한, **오류 처리**를 통해 보다 안정적인 API를 만드는 방법도 다뤘습니다.

다음 강의에서는 **BoxLang을 사용한 고급 API 설계**와 **인증 및 권한 관리**에 대해 다룰 예정입니다. **JWT** 토큰을 활용한 인증 방식이나, **API 보안**에 대해 더 심도 깊은 내용을 배울 수 있습니다. 많은 기대 바랍니다!