[JAVA] 자바 GET, POST, PUT, DELETE REST API 호출 방법 & 예제

백엔드 개발을 진행할때 프론트 서버와 API 서버를 따로 분리 하거나 혹은 다른 회사의 REST API를 호출해야 합니다. 그럴경우 API 서버의 METHOD에 맞게 Http를 사용하여 호출하여야 합니다.

 

 

아래의 소스 예제의 경우 GET, POST, PUT, DELETE를 사용 할 수 있습니다. callApi method를 호출 시 type에 REST API의 METHOD 타입을 설정해 주시면 됩니다.

데이터를 담아서 호출 할 경우 JSON 형식의 데이터로 셋팅 후 호출 하시면 됩니다. 기본적인 WEB APPLICATION 방식으로 예제를 들어 보겠습니다.

 

1. 컨트롤러에서 특정 API를 호출 합니다. HTTP METHOD 방식은 POST로 하겠습니다.

 

@Controller
public class MainController {    
    
    @GetMapping("/main")
    public String mainIndexPage() {
        
        JsonObject param = new JsonObject();
        // POST 방식으로 호출.(GET, POST, PUT, DELETE 다 가능 합니다.)
        HttpUtil.callApi(param, "POST");
        
        return "/tiles/view/main";
    }
}

 

2. REST API에 같이 보낼 데이터를 JSON 타입으로 셋팅 후 호출을 합니다. 호출 후 응답 데이터 타입도 JSON으로 받으면 됩니다.

 

public class HttpUtil {
 
    public static void callApi(JsonObject params, String type){
        
        HttpURLConnection conn = null;
        JSONObject responseJson = null;
        
        try {
            //URL 설정
            URL url = new URL("http://localhost:8080/test/api/action");
 
            conn = (HttpURLConnection) url.openConnection();
            
            // type의 경우 POST, GET, PUT, DELETE 가능
            conn.setRequestMethod(type);
            conn.setRequestProperty("Content-Type", "application/json");
            conn.setRequestProperty("Transfer-Encoding", "chunked");
            conn.setRequestProperty("Connection", "keep-alive");
            conn.setDoOutput(true);
            
            
            BufferedWriter bw = new BufferedWriter(new OutputStreamWriter(conn.getOutputStream()));
            // JSON 형식의 데이터 셋팅
            JsonObject commands = new JsonObject();
            JsonArray jsonArray = new JsonArray();
            
            params.addProperty("key", 1);
            params.addProperty("age", 20);
            params.addProperty("userNm", "홍길동");
 
            commands.add("userInfo", params);
             // JSON 형식의 데이터 셋팅 끝
            
            // 데이터를 STRING으로 변경
            Gson gson = new GsonBuilder().setPrettyPrinting().create();
            String jsonOutput = gson.toJson(commands);
                 
            bw.write(commands.toString());
            bw.flush();
            bw.close();
            
            // 보내고 결과값 받기
            int responseCode = conn.getResponseCode();
            if (responseCode == 200) {
                 BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream()));
                StringBuilder sb = new StringBuilder();
                String line = "";
                while ((line = br.readLine()) != null) {
                    sb.append(line);
                }
                responseJson = new JSONObject(sb.toString());
                
                // 응답 데이터
                System.out.println("responseJson :: " + responseJson);
            } 
        } catch (MalformedURLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (JSONException e) {
            System.out.println("not JSON Format response");
            e.printStackTrace();
        }
    }
}

 

위의 소스에서 대략적인 설명을 다해놔서 따로 소스에 대해서 설명 드릴거는 없을거 같습니다. 따로 궁금한 사항이 있으시면 댓글로 남겨 주시면 바로 답변 드리겠습니다.

 

 

 

추천글

[Java] 자바 Map to JSONObject, JSONObject to Map 사용법 & 예제

[Java] 자바 문자열 치환, 변경(replace) 예제&설명

[ Java ] 자바 String to Json 방법 설명 & String을 Json형식으로 형변환 방법

[SpringBoot] 스프링부트 로그 설정방법 & LOGBACK 설정방법 설명