이번 시간에는 REST API 요청을 테스트하기 위한 API 테스트 툴인 Postman의 기본 사용법을 알아보도록 하겠습니다.

API 요청을 보내는 최소한의 사용법만 살펴볼 예정이므로 Postman의 세부 기능이 궁금하신 분들은 공식 사이트의 매뉴얼을 참고해주세요.

Postman은 웹에서도 사용 가능하지만 여기서는 편의를 위해 실행 파일을 다운로드한 후, 설치하는 것을 기준으로 설명합니다.
이 글의 Postman 실행 파일은 Windows 기준이지만 다른 OS의 경우도 사용법은 크게 다르지 않을 것이라 생각합니다.

실행 파일 다운로드

Postman 사이트에서 Postman 실행 파일을 다운로드 받습니다.

 

실행 파일 설치

다운로드 받은 실행 파일을 실행한 후, 안내에 따라서 설치합니다.

 

설치된 파일 실행

[그림 1-1] Postman 파일 실행 시 첫 화면

설치된 Postman 파일을 실행하면 [그림 1-1]과 같은 화면이 오픈됩니다. 여기서 처음 사용을 하는 분은 [Create Account] 버튼을 눌러서 계정을 생성한 후, [Sign In] 버튼을 눌러 로그인을 진행하면 됩니다.

※ Postman은 특이하게 컴퓨터에 설치된 파일을 실행해도 계정 생성이나 로그인은 웹 브라우저로 자동 이동해서 진행이 되니 이점 참고하시기 바랍니다.

 

[그림 1-2] 로그인 후, 애플리케이션 리다이렉션 메시지

로그인 후, [그림 1-2]와 같이 데스크탑 애플리케이션으로 리다이섹션 할지 묻는 창이 열립니다. [Postman 열기] 버튼을 클릭합니다.

 

워크스페이스(Workspace) 생성

[그림 1-3] 워크 스페이스 생성

[그림 1-3]과 같이 [Workspaces] 탭을 선택한 후, [Create Workspace] 버튼을 클릭한 후, 워크스페이스 이름을 입력해서 워크스페이스를 생성합니다.

 

컬렉션(Collections) 생성

[그림 1-4] 컬렉션 생성

[그림 1-4]와 같이 [+](Create new Collection) 버튼을 눌러서 컬렉션을 생성합니다.

※ 컬렉션은 원하는 API 요청들을 컬렉션 별로 구분하기 위한 일종의 그룹화라고 보면 됩니다. 프로젝트별로 컬렉션을 생성해서 API 요청 목록들을 관리하면 좋을 것 같습니다.

 

API 요청 정보 추가

[그림 1-5] API 요청 정보 추가

생성된 컬렉션의 [...] 메뉴를 클릭한 후, [Add request] 메뉴를 클릭합니다.

 

[그림 1-6] 요청 정보 입력 화면

[그림 1-6]과 같이 요청에 필요한 HTTP Method를 선택한 후, 요청에 필요한 URI를 입력합니다. 

[그림 1-6]에서는 HTTP Method로 POST를 선택했기 때문에 [Body] 탭에서 데이터 타입을 선택할 수 있습니다.

요청에 필요한 정보를 모두 입력했다면 [Send] 버튼을 눌러서 서버로부터 응답 메시지를 전달 받을 수 있습니다.

'Java Backend 개발자 되기 > RESTful API' 카테고리의 다른 글

RESTful API의 URL 작성 규칙  (4) 2022.04.12

 

REST API란?

REST(Representational State Transfer)는 HTTP 네트워크 상의 리소스(Resource, 자원)를 정의하고 해당 리소스를 URI라는 고유한 주소로 접근하는 접근 방식을 의미하며, REST API란 REST 방식을 통해서 리소스에 접근하기 위한 서비스 API를 지칭합니다.

 

REST에서 의미하는 리소스란?

REST에서 의미하는 자원은 데이터베이스에 저장된 데이터, 문서, 이미지, 동영상 등 HTTP 통신을 통해 주고 받을 수 있는 모든 것을 의미합니다.

 

URI(Uniform Resource Identifier)와 URL(Uniform Resource Locator)

URI는 네트워크 상에 있는 특정 리소스를 식별하는 통합 자원 식별자(Uniform Resource Identifier)를 의미합니다.

URL은 인터넷에 있는 리소스를 나타내는 통합 리소스 식별자를 의미하며, 우리가 흔히들 이야기하는 웹 상의 주소를 의미합니다.

URI는 URL의 상위 개념으로 볼 수 있습니다.

URI는 리소스를 식별하는 식별자 역할을 하고, URL은 리소스의 위치를 가리킵니다. 

예) http://www.itivllage.tistory.com/manage? id = 1

위 예에서 'http://www.itivllage.tistory.com/manage'까지는 리소스의 위치를 가리키는 URL이라고 할 수 있고, 'http://www.itivllage.tistory.com/manage? id = 1'는 리소스를 식별하기 위한 'id = 1'이라는 고유 식별자 붙었으므로 URI라고 할 수 있습니다.

 

REST API URI 작성 규칙

그러면 이번에는 HTTP 상에서 REST API 서비스를 만드는 입장에서 REST API URI를 작성하는 규칙들을 살펴보도록 하겠습니다.

URI 작성 기본 규칙

  • URI의 마지막이 '/'로 끝나지 않아야 합니다.
    • better
      • http://www.itivllage.tistory.com/coffees (ㅇ)
    • worse
      • http://www.itivllage.tistory.com/coffees/ (x)
  • 동사 보다는 명사를 사용합니다.
    • better
      • http://www.itivllage.tistory.com/coffees (ㅇ)
    • worse
      • http://www.itivllage.tistory.com/coffees/update (x) 
  • 단수형 보다는 복수형 명사를 사용합니다.
    • better
      • http://www.itivllage.tistory.com/coffees (ㅇ) 
    • worse
      • http://www.itivllage.tistory.com/coffee (x)
  • URI는 기본 소문자로 사용합니다.
  • 언더스코어( _ ) 대신에 하이픈(-)을 사용합니다.
  • 파일 확장자는 URI에 포함하지 않습니다.

 

 

 

URI에서 리소스 간의 관계를 표현하는 방법

REST API를 작성하다보면 특정 리소스 간의 관계를 URI로 표현해야 할 경우가 굉장히 많습니다.

이해를 위해 예시를 살펴보도록 하겠습니다.

  • 'http://www.itivllage.tistory.com/members'는 전체 회원에 대한 리소스를 의미합니다. 
  • 'http://www.itivllage.tistory.com/members/1'는 1이라는 ID를 가지는 회원에 대한 리소스를 의미합니다.. 
  • 'http://www.itivllage.tistory.com/members/1/orders'는 1이라는 ID를 가지는 회원의 주문에 대한 리소스를 의미합니다. 

 

 

 

더 읽을 거리

 

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

대한민국의 힙합 음악가에 대해서는 R-EST 문서를 참고하십시오. REST(Representational State Transfer)는 월드 와이드 웹과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식이다. 이

ko.wikipedia.org

 

7 Rules for REST API URI Design - DZone Integration

URIs, or Uniform Resource Identifiers, should be designed to be readable and clearly communicate the API resource model. These rules will help you succeed.

dzone.com

 

웹 API 디자인 모범 사례 - Azure Architecture Center

플랫폼 독립성과 서비스 진화를 지원하는 웹 API 설계를 위한 모범 사례를 알아봅니다.

docs.microsoft.com

 

'Java Backend 개발자 되기 > RESTful API' 카테고리의 다른 글

Postman 기본 사용법  (0) 2022.04.18

+ Recent posts

출처: http://large.tistory.com/23 [Large]