Postman api 문서 만들기

 

 

1. Postman 실행 후 Collections 생성 ( + 버튼 클릭 )

   - 컬렉션은 하나의 작은 프로젝트 단위 

2. 테스트 컬렉션을 생성했고 우 클릭을 통해 Add Request 클릭 

    사용할 HTTP 메소드와 지정할 URL 입력, 상단에서 Request 이름도 수정

 

3. 요청할 URL 작성 

EX) http://naver.com:3000

==> {{circles_url}}:3000 // URL 변수처럼 사용 (자주 사용할 시 미리 URL 등록)

* 변수처럼 사용할 URL 등록하기

  - 오른쪽 상단에 눈 클릭

오른쪽 상단 눈 표시 클릭

      - VARIABLE : 변수 입력

      - INTIAL VALUE, CURRENT VALUE : 호스트 입력 ( URL )

눈 표시 클릭 시 나타나는 창

4. Request 문서 작성

위 Request API 선택 후 오른쪽 클릭 후 나타나는 창

- View Documentation 선택

각 제목 옆에 마우스 커서 선택 시 연필창 아이콘과 등장

- 연필 아이콘 선택하여 각 API에 맞게 설명 일벽

- 알맞게 입력 후 오른쪽 상단에 Published 선택

 

- API 명세서 배포 후 해당 도메인으로 이동

 

 

위와 같은 Postman 완성된  API 명세서를 볼 수가 있음