OpenAPI 문서 postman에서 사용하기

Spring Rest Docs 또는 springdoc-openapi를 사용하여 생성한 OpenAPI 문서를 Swagger UI에서 사용하는 것에 대해 소개한 적이 있다.

2022.06.17 - [Study/Java] - Spring Rest Docs로 OpenAPI (Swagger) 문서를 만들어 Swagger UI로 호출하여 보기

Swagger UI를 사용해보니 OpenAPI 문서를 생성하여 테스트를 할 수 있는 부분은 편리하지만 테스트를 할 때마다 테스트한 데이터에 대한 재사용하는 것이 불편하였다.

테스트하기 위한 데이터를 보관하는 좋은 방법이 없나 찾아보다가 postman이 openapi를 import 하여 사용할 수 있다는 것을 알게 되었다.

postman은 API를 테스트하거나 모니터, mock server를 사용할 수 있도록 하는 desktop app이다.

https://www.postman.com/

비슷한 desktop app으로 insomnia도 있고 동일하게 OpenApi를 import 하여 사용할 수 있다.

https://insomnia.rest/

postman에서 OpenAPI 문서 import 하기

`Menu의 File -> import 항목` 또는 `단축키 Ctrl + O` 또는 `워크스페이스의 import 항목`을 선택한다.

또는

 

File, Folder, Link, Raw text, repository 등 다양한 곳에서 import를 할 수 있다.
(Import 할 땐 workspace를 선택하여야 import 항목이 활성화된다.)

Swagger UI는 보여주고 있는 OpenAPI 문서에 대한 링크를 화면에 늘 표기한다.

Swagger UI에서 제공하는 예제인 Swagger Petstore  Live demo로 예를 들면

https://petstore.swagger.io/

해당 문서의 OpenAPI 데이터링크가 화면 최상단에 있다.

해당 링크의 OpenAPI spec 문서를 import 하면 postman의 APIs 메뉴에 다음과 같이 보이게 된다.

OpenAPI 문서 그대로 collection으로 관리하며 그룹 별 폴더 관리, 호출 이름이나 변수명 설정 등이 문서에 설정된 대로 깔끔하게 추가된다.

또한 호출한 결과나 호출에 사용한 데이터 모두 기록된다.

swagger-ui를 사용하는 것보다 더 개인적으로 사용하기 편하고 호출한 데이터에 대한 기록도 유지할 수 있어 좋다.

OpenAPI 문서를 공통으로 공유하기 위해 경우 web으로 제공되는 swagger-ui를 사용하고 개별 테스트할 땐 postman 같은 api client tool을 사용하면 효율적일 것 같다.