API 문서라는 걸 구글 스프레드 시트 이용해서 작성할 수도 있지만
서버가 수정될때마다 해당 문서를 동기화 하는 일이 쉽지않기 때문에
API 문서 동기화 되는 플랫폼을 이용하는 게 좋을 수도 있다
그러한 플랫폼이 바로 Postman 이다.
아래 사이트를 참고하여 작성했다.
[TIL] Postman으로 API문서 만들기
Postman? postman.png Postman은 개발한 API를 테스트하기 위해 사용하는 플랫폼으로 유명하다. 많은 사람들이 이용하는 플랫폼인 만큼 다양한 기능들을 제공하고 있다. 그 중에서도 오늘은 Postman을 통해
velog.io
collection 에 request 추가하기
일단 collection을 생성해야 한다.
collection은 request 들의 폴더 역할을 한다
나는 저번에 Practice 라는 collection을 만들었었고, 그 안에 get movieList 라는 api를 저장해놨었다
collection옆에 . . . 을 누르면 Add request 가 있다.
원하는 collection에 request 를 추가해보자.
누르면 저렇게 request가 새로 생기는데
테스트할 api 의 url, header, body 값등을 채워서 request 를 구성한다음 send 를 눌러 api 요청을 보내본다.
(api 요청 후 응답으로 받은 결과는 send 옆의 save 를 눌러서 저장을 할 수 있다.)
그리고 응답받은 값을 저장하기 위해 save as example 을 눌러준다.
이러면 왼쪽의 request 바로 아래에 api 응답 예시를 저장할 수 있다.
한번 save as example 을 눌러보자.
눌렀더니
이렇게 응답의 예시가 생긴다.
API 문서 발행하기
이번에는 New 를 눌러서 Documentation 을 선택한다.
그럼 아래와 같은 창이 뜨는데
이미 존재하는 collection을 선택할거니까 Select an existing collection 을 눌러준다
나는 Practice 라는 Collection 을 이용해서 API 문서를 만들고 싶으니 Practice 를 선택한다.
Describe your collection 란에는 설명을 작성하면된다.
내 collection 설명을 보충하고 save 하면
API 문서 볼수있는 링크가 뜬다.
View Document 를 누르면 아래와 같이 보인다.
(기존에 존재하던 get movieList 는 예시였기때문에 지워준 상태이다.)
마크다운으로 작성했던 collection 설명이 보이고
api 테스트를 위해 넣었던 body와 header 를 확인할 수 있다.
이 api 문서를 팀원들에게 공유하고 싶으면 오른쪽 맨 위에 publish 버튼을 눌러줘서 링크 다른사람들한테 공유하면 된다!
공부하면서 작성한 내용이라 포스팅에 대한 피드백 환영합니다 !
글 읽어주셔서 감사합니다 ☺️
