[JAVA] Restful API 호출 가이드 예제

주제

 

웹서비스 연동, Restful에 대한 가이드를 해보자!

---

        URL url = new URL("http://HOST_URL");
        HttpURLConnection con = (HttpURLConnection) url.openConnection();
        con.setRequestMethod("GET"); //기본적으로 조회 시 사용되는 GET

        int status = con.getResponseCode();
        BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
        String inputLine;
        StringBuffer content = new StringBuffer();
        
        while((inputLine = in.readLine()) != null) 
            content.append(inputLine);
        
        in.close();
        con.disconnect();
        
        System.out.println("Response status: " + status);
        System.out.println(content.toString());

위 소스는 Restful을 호출하는 기본 예제이다.

연동을 위한 다른 lib 를 필요로 하는 게 아니라 java에서 기본적으로 import 할 수 있는 패키지로 되어있다.

별다른 문제가 없다면 GET 메서드로 호출하여 단순한 연동이 가능하다.

자세한 Restful 에 대한 내용은 아래 위키나 검색을 통해 알아볼 수 있다.

일반적으로 호출 테스트를 하고 싶다면 json-server를 구성하여 호출해 볼 수도 있다.

반복적으로 하지만 간혹 기본 호출하는 샘플을 잊을 때가 있기 때문에 공통적으로 사용 가능하도록 소스를 구성하였다.

---

REST API ? Restful이라고 하는데 웹서비스 연동방식 중 하나라고 생각하면 쉽다.

서로 다른 프로그램이 연동하는 방식 중 하나라 할  수 있다.

사실 REST라는 공통 규약을 정해서 너도 나도 규약대로만 하면 연동이 쉽다는 게 취지이다.

하지만 간혹 연동되는 형태를 보면 연동 규약이 "이렇게 하자~" 이거지...

"이렇게 해야만 한다!"가 아니다 보니 규약이 지켜지지 않은 API 연동을 보면 기능은 수행될 수 있지만

가독성이 떨어진다.

간단한 예로, GET이라는 메서드 타입은 조회라고 할 수 있다. 

무엇을 가지고 온다는 것인데 이것 말고도 POST, PUT, DELET 등이 더 있다.

하지만 경험해본 몇몇 연동 사례들 중 GET으로만 모든 것을 다해버리는 사례가 있어서... 어처구니가 없을 지경이다.

쉽게 개발하기는 편하지만 모두가 아는 REST로 개발할 경우 공부 좀 해서 그에 맞게 개발되었으면 좋겠다.

---

▼▽▼▽ 링크 ▼▽▼▽

https://ko.wikipedia.org/wiki/REST

REST - 위키백과, 우리 모두의 백과사전

 

---

- 오늘의 한 줄 -

기본부터 하나씩!

---

공감과 구독은 저에게 크나큰 힘이 됩니다♡

함께 보면 좋은 글
 json-server는 차후 테스트 가이드에서 다룰 예정