서블릿을 활용한 간단한 RESTful API 구현 방법 및 예제

RESTful 웹 서비스는 HTTP 프로토콜을 통해 클라이언트와 서버 간의 데이터를 주고받는 방식입니다. 이 글에서는 서블릿을 사용하여 간단한 RESTful API를 구현하고, JSP를 통해 이를 테스트하는 방법에 대해 알아보겠습니다.

1. RESTful API란?

REST(Representational State Transfer)는 웹 상의 자원을 정의하고 자원에 대한 주소를 지정하는 방식을 제공합니다. 각 HTTP 메서드(GET, POST, PUT, DELETE)를 사용하여 자원에 대한 CRUD(Create, Read, Update, Delete) 작업을 수행할 수 있습니다.

GET: 자원 조회
POST: 자원 생성
PUT: 자원 수정
DELETE: 자원 삭제

2. 서블릿을 사용한 RESTful API 예제

아래는 각 HTTP 메서드(GET, POST, PUT, DELETE)에 따라 다른 동작을 수행하는 서블릿 예제 코드입니다.

package com.bluesharehub;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet("/api/resource")
public class RestfulAPIServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("application/json;charset=UTF-8");
        response.getWriter().write("{\"message\": \"GET 요청 처리됨\"}");
    }

    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("application/json;charset=UTF-8");
        response.getWriter().write("{\"message\": \"POST 요청 처리됨\"}");
    }

    @Override
    protected void doPut(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("application/json;charset=UTF-8");
        response.getWriter().write("{\"message\": \"PUT 요청 처리됨\"}");
    }

    @Override
    protected void doDelete(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("application/json;charset=UTF-8");
        response.getWriter().write("{\"message\": \"DELETE 요청 처리됨\"}");
    }
}

이 서블릿은 각 HTTP 메서드에 따라 다른 JSON 응답을 반환합니다. 각각의 메서드(GET, POST, PUT, DELETE)에 따라 요청이 처리되고, 적절한 응답을 클라이언트에게 전송합니다.

3. JSP를 사용한 RESTful API 테스트

아래 JSP 파일을 통해 간단한 웹 페이지에서 각각의 HTTP 메서드 요청을 보내고, 서버로부터의 응답을 확인할 수 있습니다.

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html lang="ko">
<head>
    <meta charset="UTF-8">
    <title>RESTful API 테스트</title>
    <script>
        // GET 요청
        function sendGetRequest() {
            fetch('api/resource', {
                method: 'GET',
            })
            .then(response => response.json())
            .then(data => {
                document.getElementById('response').innerText = JSON.stringify(data);
            });
        }

        // POST 요청
        function sendPostRequest() {
            fetch('api/resource', {
                method: 'POST',
            })
            .then(response => response.json())
            .then(data => {
                document.getElementById('response').innerText = JSON.stringify(data);
            });
        }

        // PUT 요청
        function sendPutRequest() {
            fetch('api/resource', {
                method: 'PUT',
            })
            .then(response => response.json())
            .then(data => {
                document.getElementById('response').innerText = JSON.stringify(data);
            });
        }

        // DELETE 요청
        function sendDeleteRequest() {
            fetch('api/resource', {
                method: 'DELETE',
            })
            .then(response => response.json())
            .then(data => {
                document.getElementById('response').innerText = JSON.stringify(data);
            });
        }
    </script>
</head>
<body>
    <h1>RESTful API 테스트</h1>
    <button onclick="sendGetRequest()">GET 요청</button>
    <button onclick="sendPostRequest()">POST 요청</button>
    <button onclick="sendPutRequest()">PUT 요청</button>
    <button onclick="sendDeleteRequest()">DELETE 요청</button>

    <h2>응답 결과:</h2>
    <pre id="response"></pre>
</body>
</html>

4. 결과 확인

각 버튼을 클릭하면 해당 HTTP 메서드에 맞는 요청이 서블릿으로 전달되며, 응답 결과가 페이지에 출력됩니다.

실행 결과

이 방식으로 서블릿을 사용하여 간단한 RESTful API를 구축하고, 웹 클라이언트를 통해 각 메서드에 대한 요청을 테스트할 수 있습니다.

함께 보면 좋은 이전 게시글

이 글이 도움이 되셨다면 공유 부탁 드립니다.