coding/IT, CS

postman api DOCS 링크 공유

JIN_Coder 2022. 11. 11. 16:28

postman을 이용한 api명세를 작성하고 해당 api명세를 링크로 만들어 공유하는 방법

 

 

1. Collections 생성

 

2. 폴더 및 api요청 생성

 

3. api 요청 저장

 

4. 응답 값 저장

예외처리 상황 응답 값은 선택적으로 저장

 

5. Collection 및 폴더, api 명세 설명 작성

 

6. 작성한 api명세서 문서화

오른쪽 아래(Documentation)
View complete collection documentation 클릭

 

7. 문서 내용 확인 및 링크 복사

오른쪽 위 Published 클릭

 

8. 링크 공유 및 api명세 확인

Documentation에 작성한 설명들도 볼 수 있음

요청한 api url 경로 확인 및 응답 값 확인 가능

여러 상황의 응답 값도 확인 가능

api명세 링크 이동
예외처리 응답 확인

 

 

작성한 api 명세 Docs

https://documenter.getpostman.com/view/23066446/2s8YemtZ8A

 

gameDuo

## 보스레이드 PVE 컨텐츠 서비스

documenter.getpostman.com

 

'coding > IT, CS' 카테고리의 다른 글

MVC, MVP, MVVM 패턴의 이해  (0) 2022.11.18
이진 탐색법  (0) 2022.11.15
github 커밋 히스토리 삭제  (0) 2022.09.12
TCP / UDP  (0) 2022.09.04
http 상태코드  (0) 2022.08.31