Postman을 이용한 API DOCS 만들기

준비물

• Postman

postman은 백엔드 서버의 엔드포인트가 작동 하는지 확인 해주는 Tool

해당 프로그램이 없다면 다운로드 받도록 하자.
포스트맨 다운로드

API DOCS를 만들어보자!

1. postman에 get/post/patch/delete 추가!

2. API DOCS 만들기

위 이미지 왼쪽 상단의 + New 클릭

API Documentation 클릭

3. Select an exsting collection

만들어 놓은 컬렉션 중 하나 선택 후 Next

4. Write Documentation

postman api docs에서는 마크다운을 지원해준다! README.md 파일처럼 커스터마이징 해주자!

5. API DOCS만들기 성공

해당 링크로 들어간다.

6. API DOCS를 팀원들과 공유

아직 배포전이다. 오른쪽 상단의 Publish를 클릭

7. 공유 완료

하단의 Publich Collection 클릭 시 나만의 API DOCS 공유 완료!

다음의 URL을 팀원들에게 알려주자!

8. 공유된 모습

register, login api같은 경우 body에 아이디나 패스워드가 노출 될 수 있으니 조심하도록 하자!

Tip

공유된 시점에서 api가 수정되었다면 기존의 배포를 중단하고 재배포를 해야된다!

마침

postman에서 나만 볼 수 있던 api의 모습들을 팀원들과 공유 할 수 있게 되었다.
프런트와 백엔드 모두 의사소통이 원할히 개발을 하자!