API를 개발할 때에 uri, request data, response data 등을 사전에 협의해야 한다. 우리는 기획 단계에서 API 명세서를 작성했다.
맡은 API를 개발이 완료되면 로컬에서 테스트를 진행했다. 그런데 다른 사람이 개발한 API를 테스트하려면 어떻게 해야할까? 내가 개발하지 않은 API이기 때문에 이해도가 떨어졌고, header 값을 누락하거나 request data를 잘못 넣는 경우가 많았다. 그러다 postman의 API들을 json으로 공유할 수 있다는 것을 알게 되었다.
뿐만 아니라 팀으로 공유도 할 수 있었다. 이러면 동기화도 가능! 그런데 무료 버전에서는 팀당 최대 3명만 사용이 가능했다. 그래서 내가 계정을 두개 파고, BE용 & FE용을 팠다.
API에서 사용하는 전역 변수들이 있다. 예를 들어 http://localhost:8080 이나 aws ip 같은 것들. 이런 것들을 변수화해서 적용할 수 있는 기능이 environment이다.
(step 1) 로그인 API 호출 >
(step 2) response에 들어있는 토큰값 복사 >
(step 3) 각 API의 header 값을 변경
특히 jwt 로그인을 개발한 후로 header에 ACCESS_TOKEN을 넣을 때 유용했다. 이전에는 각 API를 호출할 때마다, (step 3)번이 무한히 반복되는 구조였다.. 이제는 environment의 ACCESS_TOKEN 하나만 변경해주면 된다!
그런데 로그인 API를 이해하는 사람은, response의 어떤 값을 request의 어디에 넣어야 하는지 알지만.. 그렇지 않은 사람들은 API를 호출하는 게 어려웠다. 호출할 때마다 실수도 많고. 이걸 자동화할 수 없을까?
postman의 test 기능을 넣으면 가능하다! 로그인 API에 아래와 같은 스크립트를 작성하면, (1)만 하면 (2,3)을 해준다.
이러한 기능을 사용해서, BE 간에 테스트를 원활하게 하고 + FE가 API 테스트를 하기에도 용이했다 ^__^