(백엔드시스템) PM이 알고 있으면 좋은 도구 3가지

지난 주에 이어서 IT 프로덕트 매니저로서 업무 할 때 어떤 도구를 사용하는지 소개하려고 합니다. 오늘 소개 드릴 도구는 약간 심화과정(?)에 해당하는 도구입니다. 그래서 모든 PM에게 필요한 도구는 아니고요. API 설계나 테스트까지 커버하고 있는 PM에게 필요한 도구예요. 직접 API를 호출해서 데이터를 조회하거나 DB에 쌓이는 모습까지 살펴보고자 하는 분들께 도움이 될 수 있습니다.

 

1. Postman
2. Chrome extention json formatter
3. Swagger

 

사실 이 3가지 도구는 프로덕트매니저들 중에서도 개발자분들과 더 깊은 이야기를 나누고 싶은 분들게 필요한 도구입니다. 그래서 어떤 PM 분들은 여기까지 사용해야 할 필요가 있을까? 라는 의문을 가질 수도 있는데요. 이 부분은 선택사항이니 본인의 취향에 맞춰서 활용하시면 좋을 것 같아요. 저 같은 경우에는 약간 답답함을 직접 해소해보고 싶은 마음이 컸던 것 같아요. 예를 들어 프로덕트에 장애가 발생하거나 했을 때, API에서 잘못된 결과를 반환하고 있어서 잘못되고 있는지 등등을 직접 보고 싶었던 것 같습니다. 그랬을 때 API의 DTO(Data Transfer Object)를 변경해야 겠다는 판단을 할 수도 있고요. 사실 설계부터 DTO가 맞게 설계되었는지 볼 수 있어서 개발자분들과 협업하는데도 도움이 되었습니다.

 

1. Postman

https://www.postman.com/

Postman | The Collaboration Platform for API Development

<Postman 웹사이트>

Postman은 API를 테스트 하는데 유용한 도구입니다. 담당하는 프로덕트에 API가 있다면 API들을 직접 실행시키면서 확인해볼 수 있습니다. API를 통해서 데이터를 입력하는 부분이 있다면 DB에 쌓이는 것까지 보고 싶을 수가 있는데요. 이럴 때는 DB tool을 사용해서 DB의 상태를 보는 것도 좋습니다. 이렇게 생각해보면 프로덕트 매니저가 보아야 하는 영역이 굉장히 넓죠? ㅎㅎ

(DB tool에 대해서는 별도로 언급하지 않았는데요. 저 같은 경우에는 Sequel DB 사용해서 제가 담당하는 프로덕트의 DB를 살펴보고 데이터도 확인하고 있습니다.)

조만간 JIRA의 API를 직접 호출하는 포스팅을 작성할 예정인데요. 그때 Postman을 통해서 JIRA API를 호출할 예정입니다. 그 때 실제 어떻게 활용 될 수 있는지 살펴보겠습니다. 기대해주십셔~~! ㅎㅎ

 

<Postman 사용 모습>

 

2. Chrome extention json formatter

https://chrome.google.com/webstore/detail/json-formatter/bcjindcccaagfpapjjmafapmmgkkhgoa?hl=ko-

JSON Formatter

<Json Formatter>

 

브라우저 주소입력창에 API와 Paramiter(파라미터) 정보를 입력하여 API를 조회할 수 있는데요. 이때 조회 되는 json 결과 값을 가독성 높게 변환해줍니다. 아래 예시를 통해서 한 번 확인해보겠습니다.

1) 구글 검색창에 "api test sample"이라고 검색해보겠습니다.

<api test sample 검색>

 

2) "Dummay sample rest api" 를 클릭합니다.

<dummy api example 복사하기>

 

3) "Full route URL"을 복사해서 브라우저에 입력합니다.

<크롬 브라우저에서 복사한 URL 입력하기>

 

4) 조회 결과 Json 확인하기

<Json 확인하기>

 

5) "Parsed"를 클릭하기

<Parsed 클릭한 결과가 조회하기>

 

Chrome extention json formatter 가 있고 없고에 따라서 생산성이 많이 달라지겠죠? 개발자 분들과 대화할 때도 훨씬 편안해진 상태로 대화가 가능합니다. 간단한 Json formatter 설치를 통해서 가독성을 높여보세요.

 

3. Swagger

https://swagger.io/

API Documentation & Design Tools for Teams | Swagger

Swagger는 사실 Postman과 중복일 수도 있는데요. 약간 교집합이 있지만 Swagger 만의 장점이 있습니다. 예를 들어 Swagger 자체가 DTO 정보를 포함하고 있기 때문에 API에 대해서 잘 모르더라도 테스트해보는데 어려움이 없습니다. 그리고 Swagger 도구 자체가 API를 정리정돈해주고 있으니 별도로 정리할 필요가 없겠죠?

 

1) Swagger Demo 접속하기

아래 Swagger demo에 접속해서 테스트를 해보겠습니다.

https://petstore.swagger.io/?_ga=2.56087010.855892759.1591528352-1533040765.1591528352

Swagger UI

<Swagger Demo>

 

2) (사실 아무거나 테스트해보셔도 괜찮습니다만) "GET" 방식의 API를 1개 선택하기

<Swagger API 선택하기>

 

3) "Execute"  실행하고 조회 결과 확인하기

<Swagger 결과 조회하기>

 

이제 PM이 할 일은 개발자분들께 swagger를 설치해서 API를 볼 수 있게 해달라고 요청드리는 일입니다. 그러면 API를 직접 호출하면서 이것저것 테스트할 수 있겠죠?

 

이번 포스팅에서는 API를 설계하거나 테스트할 때 도움을 받을 수 있는 3가지 도구에 대해서 확인해보았습니다. 개발자분들과의 커뮤니케이션에 도움이 되셨기를 바랍니다. ㅎㅎ