1편, API 인증 자동화로 API 호출을 좀 더 편하게 만들기.
2편, 콜렉션 수정내용 GIT 처럼 관리하기.
3편, API 호출 및 응답 예제를 작성해서 MOCK 서버 구축하기.
4편, 다양한 요청 포맷을 IMPORT/EXPORT.
4. 다양한 요청 포맷을 IMPORT/EXPORT.
POSTMAN은 HTTP Rest API 개발에 많은 편의를 제공하는 목적으로 사용되는 툴입니다. 그렇기에 실제 개발시에 API 호출을 편하게 실행시킬 수 있게 하기 위한 여러가지 기능들이 계속해서 추가되고 발전해오고 있습니다. 저는 백엔드 API개발 해오면서 최근 5년동안 POSTMAN을 사용해 오면서 기능들이 추가되어 가는 모습을 많이 지켜 볼 수 있었는데요. POSTMAN이 가장 초창기 부터 제공하던 기능이였으면서도 제가 너무나도 편하게 사용했던 기억 때문에 다른 툴보다 POSTMAN으로 정착하게 만들었던 기능을 오늘 소개하려고 합니다. 요청 가져오기와 내보내기 기능입니다.
요청 가져오기
먼저, 어떤 형식이든 HTTP요청에 대한 정보가 있는 형식이라면, 모두 가져오고자 하는 포부가 담긴 가져오기 기능 부터 살펴보겠습니다. 이 기능은 솔직히 블로그로 소개하는 것자체가 무의미 하지 않을까 하는 너무나도 쉽게 사용할 수 있는 기능이라서 민망하게 느껴지기도 합니다. 하지만, 의외로 주변에 가져오기 기능을 잘 사용하지 않는 분들을 생각보다 많이 보면서 알려드리면 좋을 것 같아 소개하려 합니다.
화면상에 보이듯이 현재 포스트맨이 가져올수 있는 형식은 OpenAPI, GraphQL, cURL, WDSL, HAR 이렇게 다섯가지 입니다. WDSL, HAR 형식은 최근에 추가 되었나 보네요. 백엔드 API개발을 하다보면, 기능 확인을위해 클라이언트를 직접 사용하면서, 호출이 어떻게 일어나고 응답되었는지 확인하기 위해 브라우저 개발자 도구를 사용 하게 될 때가 많이 있습니다. 대부분의 브라우저 개발자도구에서는 HTTP 요청 내역을 HAR이나 cURL 명렁으로 내보낼 수 있게 해주고 있기 때문에, 손쉽게 POSTMAN으로 가져와서 호출 테스트를 해볼 수 있게 됩니다. 웹앱에서 호출하는 API인 경우, 다음과 같이 너무 쉽게 가져올 수 있습니다.
OpenAPI 형식을 가져오는 것도 꽤 유용한데요. OpenAPI 문서 관리가 잘되어있는 개발 조직이라면, POSTMAN 요청 컬렉션으로 아주 쉽게 가져올 수 있습니다. OpenAPI문서를 가져오게 되면 POSTMAN 내에 API로 등록 되고, API를 collection 으로 만들어낼 수 있습니다. POSTMAN에서 API 레벨로 관리하면 몇가지 유용한 기능을 추가로 사용할 수 있는데 다음에 기회가 된다면 자세하게 소개하겠습니다.
요청 내보내기.
가져오기가 다양한 포맷으로 가져 올 수 있는 기능이었어서 내보내기 또한 동일 한 포맷으로 모두 내보낼 수 있을거라 생각했지만, 내보내기의 경우는 하나의 포맷으로만 가능합니다. POSTMAN에서 취급하는 collection format 으로만 내보내기가 가능합니다. 이 파일은 포스트맨에서만 사용되는 포맷이라 백업의 용도로만 사용 가능 합니다. 그리고 컬렉션 레벨에서만 내보내기가 가능합니다. 그래서인지 외부에서 다른 포맷으로 변환 해주는 기능들을 만들어서 공유하는 경우가 많이 검색되네요. OpenAPI 형식으로 변환해주는 오픈소스 툴, OpenAPI 형식으로 변환해주는 서비스
요청 단위로는 내보내기 기능이라기 보다는, HTTP 요청을 호출할 수 있는 각언어별 코드 혹은 cURL 명령문을 자동으로 만들어주는 기능이 있습니다. API에 대한 명세 정보가 있지는 않지만, 이 기능을 사용해서, 각 언어별 HTTP호출 코드를 가져다 사용 할 수도 있습니다.
Top comments (0)