seon99il

Spring

REST-API란 무엇이며 SpringBoot에서 RestTemplate으로 사용하는 방법

1분 소요

모든 웹 서비스에는 엔드포인트가 있습니다. https://www.google.com/, https://medium.com/ 같은 것들이죠. 그곳(엔드포인트)으로 요청을 보내면 결과(HTML, CSS, JS 또는 값)를 받을 수 있습니다.

이번 글에서는 Spring Boot에서 다른 서비스로 요청을 보내는 방법을 소개하려고 합니다.

그 전에 REST-API를 간단히 설명하겠습니다.

REST 구성

간단히 말해 REST API는 다음으로 구성됩니다.

  • RESOURCE (URL)
  • Verb: (HTTP METHOD)
  • Message: (요청 값)

Spring @GetMapping @PutMapping @PostMapping @DeleteMapping @PatchMapping Difference — 각 메서드의 차이점은 이 글에 설명되어 있습니다.

간단한 예시로 설명하겠습니다.

예) “SeongGil”이라는 user를 생성: create는 메서드, user는 생성되는 리소스, SeongGil은 메시지입니다.

POST) https://www.service.com/users

예 2) item에서 Candy A의 정보 조회: Get은 메서드, item은 리소스, candy는 메시지입니다.

GET) https://www.service.com/item/?itemName=candy_A
{
    "itemName" : "candy_A",
    "itemPrice" : "15$"
}

REST의 특징

  1. 웹의 모든 리소스에 고유한 URI를 활용
  2. 다양한 클라이언트 (Web, App) 에 서비스 제공

사용 방법

이제 Spring에서 사용하는 방법을 알아보겠습니다.

이전에 만들었던 코드를 예시로 들겠습니다.

사업자 번호를 인증하는 기능입니다. 한국의 오픈 API를 사용합니다.

순서는 다음과 같이 정리됩니다.

  1. 요청할 url 정의
  2. Header 생성
  3. body 생성
  4. body와 header 결합
  5. 요청 전송

header와 body는 Map 타입입니다: header.add("key", "value"), body.add("key", "value")

이 기능에는 서비스 키와 businessNumber가 필요합니다.

  • serviceKey: 이 API를 사용할 권한이 있는가?
  • businessNumber: 어떤 사업자 번호에 대한 것인가?

자주 사용하므로 Bean으로 등록하겠습니다.

SellerServiceApplication.java

Service

상황에 따라 return type을 변경하세요.

결과

tax_type: 등록되지 않은 사업자 번호

이전 글

전체 글 보기 →

댓글