Lua 중급 네트워크

Lua API 설계 및 사용

Lua API 설계 및 사용 — 중급

API 설계 및 사용

1. 도입 (왜 배워야 하는가)

API(Application Programming Interface)는 소프트웨어 컴포넌트 간의 상호 작용을 정의하는 중요한 요소입니다. 실무에서 API를 설계하고 사용하는 것은 필수적입니다. 현대의 소프트웨어는 다양한 서비스와 상호 작용해야 하며, API는 이들 간의 다리 역할을 합니다. 만약 API 설계 및 사용을 제대로 이해하지 못한다면, 다음과 같은 문제가 발생할 수 있습니다:

통합의 어려움: 다른 시스템과의 연결이 원활하지 않아 기능이 제한됩니다.
유지보수의 복잡성: API가 잘못 설계되면 코드의 수정 및 관리가 어려워집니다.
확장성 저하: 잘못된 API 설계는 향후 기능 추가에 큰 장애가 될 수 있습니다.

2. 핵심 개념 설명

RESTful API: HTTP 프로토콜을 기반으로 하는 API 설계 스타일입니다. 예를 들어, 웹에서 정보를 요청할 때 'GET', 'POST' 같은 메서드를 사용합니다. 이는 마치 식당에서 메뉴를 보고 주문하는 것과 같습니다.
JSON: JavaScript Object Notation의 약자로, 데이터를 저장하고 전송하는 데 사용되는 형식입니다. 인간이 읽기 쉬운 구조를 가지고 있어 정보를 쉽게 교환할 수 있습니다. 이는 마치 친구에게 이메일을 보내는 것과 비슷합니다.
엔드포인트: API의 특정 기능을 제공하는 URL입니다. 마치 도서관에서 특정 책을 찾아가는 경로와 같습니다.

용어	설명
API	소프트웨어 간의 상호작용 인터페이스
RESTful API	HTTP 프로토콜을 따르는 API 설계 스타일
JSON	데이터를 교환하기 위한 경량 포맷
엔드포인트	특정 기능을 제공하는 URL

3. 기본 코드 예제

아래는 Lua에서 간단한 RESTful API를 호출하여 JSON 데이터를 받아오는 예제입니다.

local http = require("socket.http")
local json = require("dkjson")

-- API 엔드포인트 설정
local url = "https://jsonplaceholder.typicode.com/posts/1"

-- GET 요청을 보내고 응답을 받음
local response, status = http.request(url)

-- 상태가 200(성공)이면 JSON 파싱
if status == 200 then
    local data = json.decode(response)
    print("제목: " .. data.title)
else
    print("오류 발생: " .. status)
end

실행 결과:

제목: sunt aut facere repellat provident occaecati excepturi optio reprehenderit

코드 설명:

local http = require("socket.http"): Lua의 socket 라이브러리를 불러옵니다.
local json = require("dkjson"): JSON 처리 라이브러리를 불러옵니다.
local url = "https://jsonplaceholder.typicode.com/posts/1": API 엔드포인트를 설정합니다.
local response, status = http.request(url): GET 요청을 보내고 응답을 받습니다.
if status == 200 then: 응답이 성공적일 경우.
local data = json.decode(response): JSON 데이터를 Lua 테이블로 변환합니다.
print("제목: " .. data.title): 제목을 출력합니다.
else print("오류 발생: " .. status): 오류가 발생하면 상태 코드를 출력합니다.

4. 실전 활용 예제

쇼핑몰 장바구니 구현: 사용자가 상품을 장바구니에 추가할 때 API를 호출하여 서버에 데이터를 저장합니다.

local json = require("dkjson")
local http = require("socket.http")

local cartItem = {
    productId = 123,
    quantity = 2
}

local response, status = http.request{
    url = "https://example.com/api/cart/add",
    method = "POST",
    headers = {
        ["Content-Type"] = "application/json"
    },
    body = json.encode(cartItem)
}

사용자 정보 업데이트: 사용자 정보를 수정하기 위해 API에 PUT 요청을 보냅니다.

local userData = {
    id = 1,
    name = "John Doe",
    email = "[email protected]"
}

local response, status = http.request{
    url = "https://example.com/api/users/1",
    method = "PUT",
    headers = {
        ["Content-Type"] = "application/json"
    },
    body = json.encode(userData)
}

5. 흔한 실수와 주의사항

HTTP 메서드 혼동: POST와 PUT을 혼용하여 사용하지 않도록 주의해야 합니다.

- 잘못된 코드:

   local response = http.request("POST", url, body) -- PUT 요청을 보내야 하는데 POST로 잘못 작성

- 올바른 코드:

   local response = http.request("PUT", url, body)

JSON 형식 오류: JSON 데이터를 올바르게 인코딩하지 않으면 서버에서 오류가 발생합니다.

- 잘못된 코드:

   body = "{id:1,name:John Doe}" -- 잘못된 JSON 형식

- 올바른 코드:

   body = json.encode({id = 1, name = "John Doe"}) -- 올바른 JSON 형식

6. 정리

API는 소프트웨어 간의 상호작용을 위한 필수 요소입니다.
RESTful API와 JSON은 현대 웹 개발에서 널리 사용되는 기술입니다.
엔드포인트는 특정 기능을 제공하며, 이를 통해 필요한 정보를 요청할 수 있습니다.

다음에 학습하면 좋은 주제:

OAuth와 같은 인증 메커니즘
GraphQL API 설계
Lua에서 비동기 API 호출 처리 방법