Testing/Postman

[Postman] API 요청 보내기

혬수 2024. 3. 13. 02:19

 

📍 Postman 이란?

API 개발을 위한 테스팅 및 문서화 도구이다.

사용자 친화적인 인터페이스와 API 문서 작성, 모니터링 등 다양한 기능을 제공한다.

 

또는 데스크톱 앱으로 접속 가능

 

https://www.postman.com/downloads/

 

Download Postman | Get Started for Free

Try Postman for free! Join 30 million developers who rely on Postman, the collaboration platform for API development. Create better APIs—faster.

www.postman.com

 

 

📍 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://learning.postman.com/

 

Learning Center | Postman Learning Center

Learning Center: documentation for Postman, the collaboration platform for API development. Create better APIs—faster.

learning.postman.com

https://inpa.tistory.com/entry/POSTMAN-%F0%9F%92%BD-%ED%8F%AC%EC%8A%A4%ED%8A%B8%EB%A7%A8-%EC%82%AC%EC%9A%A9%EB%B2%95-API-%ED%85%8C%EC%8A%A4%ED%8A%B8-%EC%9E%90%EB%8F%99%ED%99%94-%EA%B3%A0%EA%B8%89-%ED%99%9C%EC%9A%A9%EA%B9%8C%EC%A7%80

 

💽 POSTMAN 사용법 - API 테스트 자동화 고급 활용까지

포스트맨 (POSTMAN) POSTMAN은 API를 개발, 테스트, 공유 및 문서화하는 데 사용되는 API 클라이언트 이다. 엔드 포인트 URL을 입력하는 테스트에 사용되며 서버로 요청을 보내고 서버에서 응답을 받아 a

inpa.tistory.com

https://devchul.tistory.com/12

 

[API] REST API 및 URL 요청 테스트! (POSTMAN)

POST MAN 소개 Advanced Rest Client 외에 또 다른 종류의 테스트 툴을 다뤄 볼까 합니다. 웹 개발을 하신다면 한 번쯤은 들어 보셨을 "POSTMAN" 인데 간단히 테스트 할 수 있는 방법을 소개 하겠습니다. 먼

devchul.tistory.com