[내일배움캠프_Spring Boot 숙련주차] RestTemplate & Open API

RestTemplate이란 무엇일까?

Server To Server

지금까지는 브라우저 Client로부터 요청을 받는 서버의 입장에서 개발을 진행해왔음
서비스 개발을 진행하다보면 라이브러리 사용만으로는 구현이 힘든 기능들이 무수히 많이 존재함
ex) 회원가입을 진행할 때 사용자의 주소를 받아야 한다면, 주소를 검색할 수 있는 기능을 구현해야 하는데 직접 구현을 하게 되면 많은 시간과 비용이 들어감
이때, 카카오에서 만든 주소 검색 API를 사용한다면 해당 기능을 간편하게 구현할 수 있음
이러한 경우 우리의 서버는 Client 입장이 되어 Kakao 서버에 요청을 진행해야 함

Spring에서는 서버에서 다른 서버로 간편하게 요청할 수 있도록 RestTemplate 기능을 제공하고 있음

Client 입장의 Server(초기세팅)

Client 입장의 Server 포트 번호: 8080

Controller

package com.sparta.springresttemplateclient.controller;

import com.sparta.springresttemplateclient.dto.ItemDto;
import com.sparta.springresttemplateclient.service.RestTemplateService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@RequestMapping("/api/client")
public class RestTemplateController {

    private final RestTemplateService restTemplateService;

    public RestTemplateController(RestTemplateService restTemplateService) {
        this.restTemplateService = restTemplateService;
    }

    @GetMapping("/get-call-obj")
    public ItemDto getCallObject(String query) {
        return restTemplateService.getCallObject(query);
    }

    @GetMapping("/get-call-list")
    public List<ItemDto> getCallList() {
        return restTemplateService.getCallList();
    }

    @GetMapping("/post-call")
    public ItemDto postCall(String query) {
        return restTemplateService.postCall(query);
    }

    @GetMapping("/exchange-call")
    public List<ItemDto> exchangeCall(@RequestHeader("Authorization") String token) {
        return restTemplateService.exchangeCall(token);
    }
}

DTO

package com.sparta.springresttemplateclient.dto;

import lombok.Getter;
import lombok.NoArgsConstructor;

@Getter
@NoArgsConstructor
public class ItemDto {
    private String title;
    private int price;
}

Entity

package com.sparta.springresttemplateclient.entity;

import lombok.Getter;

@Getter
public class User {
    private String username;
    private String password;

    public User(String username, String password) {
        this.username = username;
        this.password = password;
    }
}

Service

package com.sparta.springresttemplateclient.service;

import com.sparta.springresttemplateclient.dto.ItemDto;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

import java.util.List;

@Slf4j
@Service
public class RestTemplateService {

    public ItemDto getCallObject(String query) {
        return null;
    }

    public List<ItemDto> getCallList() {
        return null;
    }

    public ItemDto postCall(String query) {
        return null;
    }

    public List<ItemDto> exchangeCall(String token) {
        return null;
    }
}

﹡순서 흐름: Client 입장의 Server의 Controller로 요청 → Service를 거쳐 Server 입장의 Server로 요청이 보내짐(RestTemplate을 사용) → 요청에 관한 로직 처리 후 응답 반환 → 다시 Client 입장의 Server를 통해 최종적으로 응답을 받음

Server 입장의 Server(초기세팅)

Server 입장의 Server 포트 번호: 7070
해당 서버는 Client 입장의 Server가 보낸 요청을 받는 Controller

// application.properties
server.port = 7070

Controller

package com.sparta.springresttemplateserver.controller;

import com.sparta.springresttemplateserver.dto.ItemResponseDto;
import com.sparta.springresttemplateserver.dto.UserRequestDto;
import com.sparta.springresttemplateserver.entity.Item;
import com.sparta.springresttemplateserver.service.ItemService;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/server")
public class ItemController {

    private final ItemService itemService;

    public ItemController(ItemService itemService) {
        this.itemService = itemService;
    }

    @GetMapping("/get-call-obj")
    public Item getCallObject(@RequestParam String query) {
        return itemService.getCallObject(query);
    }

    @GetMapping("/get-call-list")
    public ItemResponseDto getCallList() {
        return itemService.getCallList();
    }

    @PostMapping("/post-call/{query}")
    public Item postCall(@PathVariable String query, @RequestBody UserRequestDto requestDto) {
        return itemService.postCall(query, requestDto);
    }

    @PostMapping("/exchange-call")
    public ItemResponseDto exchangeCall(@RequestHeader("X-Authorization") String token, @RequestBody UserRequestDto requestDto) {
        return itemService.exchangeCall(token, requestDto);
    }
}

DTO

package com.sparta.springresttemplateserver.dto;

import com.sparta.springresttemplateserver.entity.Item;
import lombok.Getter;

import java.util.ArrayList;
import java.util.List;

@Getter
public class ItemResponseDto {
    private final List<Item> items = new ArrayList<>();

    public void setItems(Item item) {
        items.add(item);
    }
}

package com.sparta.springresttemplateserver.dto;

import lombok.Getter;

@Getter
public class UserRequestDto {
    private String username;
    private String password;
}

Entity

package com.sparta.springresttemplateserver.entity;

import lombok.Getter;

@Getter
public class Item {
    private String title;
    private int price;

    public Item(String title, int price) {
        this.title = title;
        this.price = price;
    }
}

Service

package com.sparta.springresttemplateserver.service;

import com.sparta.springresttemplateserver.dto.ItemResponseDto;
import com.sparta.springresttemplateserver.dto.UserRequestDto;
import com.sparta.springresttemplateserver.entity.Item;
import org.springframework.stereotype.Service;

import java.util.Arrays;
import java.util.List;

@Service
public class ItemService {

    private final List<Item> itemList = Arrays.asList(
            new Item("Mac", 3_888_000),
            new Item("iPad", 1_230_000),
            new Item("iPhone", 1_550_000),
            new Item("Watch", 450_000),
            new Item("AirPods", 350_000)
    );

    public Item getCallObject(String query) {
        return null;
    }

    public ItemResponseDto getCallList() {
        return null;
    }

    public Item postCall(String query, UserRequestDto requestDto) {
        return null;
    }

    public ItemResponseDto exchangeCall(String token, UserRequestDto requestDto) {
        return null;
    }
}

RestTemplate의 Get 요청

객체 하나만 가져오기

Client 입장의 Server

RestTemplate 주입 받아와 사용하기

// RestTemplateService

...
@Slf4j
@Service
public class RestTemplateService {

    private final RestTemplate restTemplate;

    // RestTemplate을 Spring Boot에서 자동 등록을 처음에 수행하지 않음
    // 그렇기 때문에 RestTemplate을 만들 수 있는 RestTemplate builder를 등록해줘야함
    public RestTemplateService(RestTemplateBuilder builder) {
        this.restTemplate = builder.build();
    }


	...
}

Client 쪽 GET 요청 만들기

// RestTemplateService.java
public ItemDto getCallObject(String query) {
    // 요청 URL 만들기
    URI uri = UriComponentsBuilder
            .fromUriString("http://localhost:7070") // 서버 입장의 서버에 보낼 준비
            .path("/api/server/get-call-obj") // 서버 입장의 서버의 Controller 부분
            .queryParam("query", query) // ?검색어
            .encode()
            .build()
            .toUri();
    log.info("uri = " + uri);

    // GET 방식으로 해당 URI 서버에 요청이 보내짐
    // getForEntity(URI, 요청을 한 다음 받을 응답 DTO);
    // :두 번째 파라미터는 서버의 서버로부터 넘어오는 데이터를 받아줄 Class 타입을 지정하면, 자동으로 역직렬화가 되어서 객체 형태로 담김
    ResponseEntity<ItemDto> responseEntity = restTemplate.getForEntity(uri, ItemDto.class);

    log.info("statusCode = " + responseEntity.getStatusCode());

    return responseEntity.getBody();
}

Server 입장의 Server

// ItemService
// 검색어에 해당하는 Item 반환
public Item getCallObject(String query) {
    for (Item item : itemList) {
        if(item.getTitle().equals(query)) {
            return item;
        }
    }
    return null;
}

객체 여러개 가져오기

Client 입장의 Server

JSON을 다루기 위해 dependencies에 아래 코드 추가

// json
implementation 'org.json:json:20230227'

RestTemplateService에 객체 여러개 가져오는 비즈니스 코드 추가
- 여러개 받아오기 위해 String 객체로 가져오기

package com.sparta.springresttemplateclient.service;

...

@Slf4j
@Service
public class RestTemplateService {

	...

    public List<ItemDto> getCallList() {
        // 요청 URL 만들기
        URI uri = UriComponentsBuilder
                .fromUriString("http://localhost:7070")
                .path("/api/server/get-call-list")
                .encode()
                .build()
                .toUri();
        log.info("uri = " + uri);

        ResponseEntity<String> responseEntity = restTemplate.getForEntity(uri, String.class); // 여러개를 받아오기 위해 String으로 받아오기

        log.info("statusCode = " + responseEntity.getStatusCode());
        log.info("Body = " + responseEntity.getBody());

        return fromJSONtoItems(responseEntity.getBody());
    }
	...

//    넘어오는 JSON 형태(중첩 JSON)
//    {
//        "items": [
//        {"title":"Mac", "price": 3888000},
//        {"title":"iPad", "price": 1230000},
//        {"title":"iPhone", "price": 1550000},
//        {"title":"Watch", "price": 450000},
//        {"title":"AirPods", "price": 350000}
//        ]
//    }
    public List<ItemDto> fromJSONtoItems(String responseEntity) {
        // JSONObject의 getJSONArray 메서드에 key값을 주기
        JSONObject jsonObject = new JSONObject(responseEntity);
        JSONArray items  = jsonObject.getJSONArray("items");
        List<ItemDto> itemDtoList = new ArrayList<>();

        for (Object item : items) {
            ItemDto itemDto = new ItemDto((JSONObject) item);
            itemDtoList.add(itemDto);
        }

        return itemDtoList;
    }
}

ItemDto에 생성자 추가

package com.sparta.springresttemplateclient.dto;

import lombok.Getter;
import lombok.NoArgsConstructor;
import org.json.JSONObject;

@Getter
@NoArgsConstructor
public class ItemDto {
    private String title;
    private int price;

    public ItemDto(JSONObject itemJson) {
        this.title = itemJson.getString("title");
        this.price = itemJson.getInt("price");
    }
}

Server 입장의 Server

// ItemService.java 내 아래 코드 추가
public ItemResponseDto getCallList() {
    ItemResponseDto responseDto = new ItemResponseDto();
    for (Item item : itemList) {
        responseDto.setItems(item);
    }
    return responseDto;
}

RestTemplate의 Post 요청

Client 입장의 Server

// RestTemplateService.java
public ItemDto postCall(String query) {
    // 요청 URL 만들기
    URI uri = UriComponentsBuilder
            .fromUriString("http://localhost:7070")
            .path("/api/server/post-call/{query}") // Path Variable 방식
            .encode()
            .build()
            .expand(query)
            .toUri();
    log.info("uri = " + uri);

    User user = new User("Robbie", "1234");

    // postForEntity(URI, HttpBody에 넣어줄 데이터, 전달받을 데이터와 mapping할 것)
    // 두 번째 파라미터는 RestTemplate이 자동으로 JSON으로 변경해줌
    ResponseEntity<ItemDto> responseEntity = restTemplate.postForEntity(uri, user, ItemDto.class);

    log.info("statusCode = " + responseEntity.getStatusCode());

    return responseEntity.getBody();
}

Server 입장의 Server

// ItemService.java
public Item postCall(String query, UserRequestDto userRequestDto) {
    System.out.println("userRequestDto.getUsername() = " + userRequestDto.getUsername());
    System.out.println("userRequestDto.getPassword() = " + userRequestDto.getPassword());

    return getCallObject(query);
}

RestTemplate의 exchange

Header에 데이터를 담아서 요청하는 방법

Client 입장의 Server

// RestTemplateService
public List<ItemDto> exchangeCall(String token) {
    // 요청 URL 만들기
    URI uri = UriComponentsBuilder
            .fromUriString("http://localhost:7070")
            .path("/api/server/exchange-call")
            .encode()
            .build()
            .toUri();
    log.info("uri = " + uri);

    User user = new User("Robbie", "1234"); // Body에 보낼 데이터

    RequestEntity<User> requestEntity = RequestEntity
            .post(uri) // Method 지정
            .header("X-Authorization", token) // Header 추가
            .body(user); // body 부분

    // exchange(RequestEntity 객체, 받아올 객체)
    ResponseEntity<String> responseEntity = restTemplate.exchange(requestEntity, String.class);

    return fromJSONtoItems(responseEntity.getBody());
}

Server 입장의 Server

// ItemService.java
public ItemResponseDto exchangeCall(String token, UserRequestDto requestDto) {
    System.out.println("token = " + token);
    System.out.println("requestDto.getUsername() = " + requestDto.getUsername());
    System.out.println("requestDto.getPassword() = " + requestDto.getPassword());

    return getCallList();
}

Naver Open API

네이버가 제공하는 API 목록

1. 애플리케이션 등록

네이버 검색 API 사용법 상세 설명

1-1) Postman으로 Naver API 요청해보기

Client ID와 Client Secret 값 넣어줘야함

2. Client 입장의 서버에 Naver 상품 검색 API 기능 붙이기

DTO 생성

응답 예시(출처: https://developers.naver.com/docs/serviceapi/search/shopping/shopping.md#%EC%87%BC%ED%95%91)

package com.sparta.springresttemplateclient.naver.dto;

import lombok.Getter;
import lombok.NoArgsConstructor;
import org.json.JSONObject;

@Getter
@NoArgsConstructor
public class ItemDto {
    private String title;
    private String link;
    private String image;
    private int lprice;

    public ItemDto(JSONObject itemJson) {
        this.title = itemJson.getString("title");
        this.link = itemJson.getString("link");
        this.image = itemJson.getString("image");
        this.lprice = itemJson.getInt("lprice");
    }
}

Controller 구현

package com.sparta.springresttemplateclient.naver.controller;

import com.sparta.springresttemplateclient.naver.dto.ItemDto;
import com.sparta.springresttemplateclient.naver.service.NaverApiService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@RequestMapping("/api")
public class NaverApiController {

    private final NaverApiService naverApiService;

    public NaverApiController(NaverApiService naverApiService) {
        this.naverApiService = naverApiService;
    }

    @GetMapping("/search")
    public List<ItemDto> searchItems(@RequestParam String query)  {
        return naverApiService.searchItems(query);
    }
}

Service 구현

요청 예시(출처: https://developers.naver.com/docs/serviceapi/search/shopping/shopping.md#%EC%87%BC%ED%95%91)

package com.sparta.springresttemplateclient.naver.service;

import com.sparta.springresttemplateclient.naver.dto.ItemDto;
import lombok.extern.slf4j.Slf4j;
import org.json.JSONArray;
import org.json.JSONObject;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.http.RequestEntity;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;

import java.net.URI;
import java.util.ArrayList;
import java.util.List;

@Slf4j(topic = "NAVER API")
@Service
public class NaverApiService {

    private final RestTemplate restTemplate;

    public NaverApiService(RestTemplateBuilder builder) {
        this.restTemplate = builder.build();
    }

    public List<ItemDto> searchItems(String query) {
        // 요청 URL 만들기
        URI uri = UriComponentsBuilder
                .fromUriString("https://openapi.naver.com")
                .path("/v1/search/shop.json")
                .queryParam("display", 15) // 15개씩 가져오(Default: 10)
                .queryParam("query", query)
                .encode()
                .build()
                .toUri();
        log.info("uri = " + uri);

        RequestEntity<Void> requestEntity = RequestEntity
                .get(uri)
                // 헤더 추가
                .header("X-Naver-Client-Id", "Client-Id")
                .header("X-Naver-Client-Secret", "Client-Secret")
                .build();

        ResponseEntity<String> responseEntity = restTemplate.exchange(requestEntity, String.class);

        log.info("NAVER API Status Code : " + responseEntity.getStatusCode());

        return fromJSONtoItems(responseEntity.getBody());
    }

    public List<ItemDto> fromJSONtoItems(String responseEntity) {
        JSONObject jsonObject = new JSONObject(responseEntity);
        JSONArray items  = jsonObject.getJSONArray("items");
        List<ItemDto> itemDtoList = new ArrayList<>();

        for (Object item : items) {
            ItemDto itemDto = new ItemDto((JSONObject) item);
            itemDtoList.add(itemDto);
        }

        return itemDtoList;
    }
}

﹡ 필요한 데이터만 가져오기 위해 가공해서 반환할 수 있음!

'백엔드 > spring&springboot' 카테고리의 다른 글

[내일배움캠프_Spring Boot 숙련주차] JPA 한 걸음 더 나아가기(지연 로딩과 즉시 로딩, 영속성 전이, 고아 Entity) (0)	2026.06.30
[내일배움캠프_Spring Boot 숙련주차] JPA 한 걸음 더 나아가기(Entity 연관관계, 1대 1, N대 1, 1대 N, N대 M) (0)	2026.06.30
[내일배움캠프_Spring Boot 숙련주차] 데이터 검증하기(Validation) (0)	2026.06.29
[내일배움캠프_Spring Boot 숙련주차] 사용자 관리하기(Spring Security, 접근 불가 페이지 만들기) (0)	2026.06.29
[내일배움캠프_Spring Boot 숙련주차] 사용자 관리하기(회원가입, 로그인 구현 with JWT, 필터) (0)	2026.06.29

차곡차곡🐿️

[내일배움캠프_Spring Boot 숙련주차] RestTemplate & Open API

RestTemplate이란 무엇일까?

Server To Server

Client 입장의 Server(초기세팅)

Server 입장의 Server(초기세팅)

RestTemplate의 Get 요청

객체 하나만 가져오기

객체 여러개 가져오기

RestTemplate의 Post 요청

RestTemplate의 exchange

Naver Open API

1. 애플리케이션 등록

2. Client 입장의 서버에 Naver 상품 검색 API 기능 붙이기

'백엔드 > spring&springboot' 카테고리의 다른 글

티스토리툴바

[내일배움캠프_Spring Boot 숙련주차] RestTemplate & Open API

RestTemplate이란 무엇일까?

Server To Server

Client 입장의 Server(초기세팅)

Server 입장의 Server(초기세팅)

RestTemplate의 Get 요청

객체 하나만 가져오기

객체 여러개 가져오기

RestTemplate의 Post 요청

RestTemplate의 exchange

Naver Open API

1. 애플리케이션 등록

2. Client 입장의 서버에 Naver 상품 검색 API 기능 붙이기

'백엔드 > spring&springboot' 카테고리의 다른 글

관련글

티스토리툴바