[Spring boot ] REST API - 01 REST API & POSTMAN
REST(Representational Safe Transfer)
데이터를 주고 받는 방식의 아키텍처(디자인 패턴)
1. HTTP URL를 통한 자원의 명시
(1) 쿼리 스트링 방식이 아니라 PathVariable 방식 사용
(2) 대문자 사용 지양
(3) ' _ '대신 ' - ' 사용
(4) URL 마지막에 ' / ' 사용하지 않음
(5) URL에 행위를 포함하지 않음(insert, update, delete)
(6) 가급적 명사 사용(동사 사용 지양)
2. HTTP Method로 해당 자원을 제어하는 행위를 표현
(1) GET(Read) : URL/1
(2) POST(Create) : URL
(3) PUT(Update) : URL/1
(4) DELETE (Delete) : URL/1
Restful 서비스(API)
- REST 아키텍처를 준수하는 서비스
RESTful 서비스에서는 Controller에서 요청 받은 내용을 처리하고 데이터를 가공해서 처리 결과를 "특정 플랫폼"에 적합한 형태의 View로 만들어서 응답하지 않고 데이터만 처리하거나 응답 데이터가 있다면 JSON/XML로 응답한다. 클라이언트는 규칙에 맞게 작업을 요청하면 되고 서버는 어떤 플랫폼에서 어떻게 사용할 것인지를 신경쓰지 않고 요청 받은 데이터만 처리하고 응답하면 된다. 클라이언트는 받은 데이터를 알아서 가공해서 사용한다. 즉, 멀티 플랫폼에서 사용 가능하다. 이러한 특성으로, 사용자 플랫폼과 view에 상관하지 않고 요청한 데이터만 응답해주는 오픈 API에서 Restful한 서비스 방식을 많이 사용한다. 어플리케이션의 복잡도 증가로 인해 서비스별 독립적 구축과 운영이 필요해지면서 많이 활용되고 있다.
POSTMAN
- API를 개발, 테스트, 공유 및 문서화하는 데 사용되는 API클라이언트
- 엔드 포인트 URL을 입력하는 테스트에서 사용되며 서버로 요청을 보내고
서버에서 응답을 받아 api가 잘 동작하는지 확인할 수 있다.
- 쿼리스트링 작업이 편리해질 뿐만 아니라 브라우저를 통해서 설정하지 못하는
Header, Body값 설정 및 수정을 작업할 수 있다.
1. POSTMAN 설치
https://www.postman.com/downloads/
Download Postman | Get Started for Free
Try Postman for free! Join 20 million developers who rely on Postman, the collaboration platform for API development. Create better APIs—faster.
www.postman.com
2. POSTMAN 기본 사용법
(1) Workspace를 별도로 만들거나 기본 Workspace인 My Workspace를 사용한다.
(2) Collection을 통해 request를 그룹화 할 수 있다.
(3) Collection 하위 폴더를 지정하여 그룹화 할 수 있으며, 폴더 하위에 request를 추가하여 저장해 둘 수 있다.
(4) 요청 Method, 요청 URL, 요청 파라미터 등을 알맞게 설정하여 응답을 확인하며 테스트를 진행한다.
