본격적인 Postman을 이용한 API request 및 Test방법에 대해 서술하기 전에, HTTP Method와 Query / Path parameter가 무엇인지 간략하게 정리하고 가고자합니다.
HTTP Method
Mozila.org 의 문서의 설명을 보자면, 어떠한 목적을 가진 request들의 정의라고 할 수 있습니다.
HTTP는 요청 메서드를 정의하여, 주어진 리소스에 수행하길 원하는 행동을 나타냅니다. 간혹 요청 메서드를 "HTTP 동사"라고 부르기도 합니다. 각각의 메서드는 서로 다른 의미를 구현하지만, 일부 기능은 메서드 집합 간에 서로 공유하기도 합니다. 이를테면 응답 메서드는 안전하거나, 캐시 가능하거나, 멱등성을 가질 수 있습니다.
즉 인터넷 상에서의 발생하는 요청들의 목적에 따라 의미를 부여하고 나타내는 것이 HTTP Method들의 역할인 것 입니다.
여러 종류가 많지만 대표적으로는,
- GET : 어떠한 데이터를 요청(조회)할 때 사용
- POST : 어떠한 데이터를 삽입(전송)할 때 사용. 데이터를 전송할때는 단순 body뿐만 아니라 첨부파일과 같은 것들도 포함.
- PUT(PATCH) : 어떠한 데이터를 갱신할 때 사용.
- DELETE : 어떠한 데이터를 삭제할 때 사용.
이 있겠습니다. CRUD의 개념과 맵핑된다고 생각하시면 좋을 것 같습니다.
Query / Path Parameter
위의 HTTP Method를 이용하여 request를 생성할때, parameter를 넘겨주게 되는데 이때 2가지의 경우가 있습니다.
Query parameter
request를 실행하고자 하는 URI의 뒤에 ? 로 시작하여 key=value 로 구성된 parameter입니다. 이때 query parameter가 여러개 오게 된다면 & 로 연결해줍니다.
query parameter는 순서를 바꾸어 기재해주어도 문제없습니다.
보통은 정렬, 조회 등이 필요할때 query paramter가 필요합니다.
Path parameter
어떠한 행위(목적) 이 지정되어있는 URI를 뜻합니다.
위는 Trello의 API Document의 Get a Board API에 대한 내용이빈다.
하나의 board의 정보를 조회하고자 한다면, /1/boards/{id} 로 request를 날려야 합니다. (id는 boardID)
여기에 query parameter로, 사용자의 API Key로 요구하고 있습니다.
이렇듯 Query / Path parameter의 생김새와 의미를 알게된다면 API Design, Test를 할 때 많은 도움이 될 것 입니다.
Ref
