📍 Postman 이란?
API 개발을 위한 테스팅 및 문서화 도구이다.
사용자 친화적인 인터페이스와 API 문서 작성, 모니터링 등 다양한 기능을 제공한다.
웹 또는 데스크톱 앱으로 접속 가능
https://www.postman.com/downloads/
📍 WorkSpace
각 WorkSpace 내 API , Collection , Environment 및 기타 Postman 요소를 공유한다.
팀과 함께 API 프로젝트를 구성하고 함께 작업할 수 있는 역할
기본적으로 My Workspace가 표시된다.
📍 요청 보내기
Postman을 통해 엔드포인트에 요청을 보내거나, 데이터 소스에서 데이터를 검색하거나, API 기능을 테스트할 수 있다.
기본적으로 요청하고 응답받을 URL가 필요하지만,
테스트를 위해 REST API를 요청하고 응답 받을 수 있는 테스트URL을 사용할 것이다.
해당 도메인의 /users 리소스를 사용
https://jsonplaceholder.typicode.com/users
요청 생성
New > HTTP
간단히 요청 하나 보낼거기에 HTTP 선택
Get 요청 보내기
Get요청은 리소스를 조회하는 경우 사용한다.
https://jsonplaceholder.typicode.com/users
Get 선택 > url 부분에 입력 > Send
Get 방식으로 요청한 결과가 보여진다.
JSON 형식뿐만 아니라 XML, HTML 등 다양한 형식으로 볼 수 있으며, 상태 코드 등 성능 지표도 확인할 수 있다.
파라미터를 url 뒤에 직접 붙여줄 필요 없이 쿼리 파라미터에 값을 넣으면 자동으로 파라미터가 생성된다.
JSON형식으로 붙여넣어도 자동으로 파라미터 생성됨.
예시) id가 2인 user
Post 요청 보내기
Post요청은 리소스를 생성/업데이트하는 경우 사용한다.
https://jsonplaceholder.typicode.com/users
Post 선택 > url 부분에 입력 > Body 작성 > Send
예시) name이 Test인 user 생성
Body는 form-data, JSON, GraphQL 등 다양한 형태를 지정할 수 있다.
요청 헤더
특정 헤더를 보내야 하는 경우, 헤더 탭에서 헤더 키-값을 작성하여 구성할 수 있다.
Postman은 요청 선택 및 설정에 따라 요청에 특정 헤더를 자동으로 추가한다. 헤더 탭 상단에서 숨김 버튼으로 숨길 수 있다.
API요청에 인증이 필요한 경우, 인증 탭에서 인증 유형을 선택하여 구성할 수 있다.
Inherit auth from parent인 경우, 상위 폴더와 collection으로 그룹화된 인증 정보를 상속받는다.
참고
https://devchul.tistory.com/12