Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

POSTMAN 을 활용한, API 문서화 #51

Open
heojae opened this issue Aug 17, 2020 · 0 comments
Open

POSTMAN 을 활용한, API 문서화 #51

heojae opened this issue Aug 17, 2020 · 0 comments

Comments

@heojae
Copy link
Contributor

heojae commented Aug 17, 2020 •
edited
Loading

현재 배포된 문서화 링크
https://documenter.getpostman.com/view/6300316/T1LS9jxh?version=latest#3a76b572-9287-499b-9917-ca8ed8b25425

  1. Postman 설치
  • 알아서 설치 할 수 있으리라 믿습니다
  1. 환경 설치

  • Manage Environment 검색
    스크린샷 2020-08-18 오전 8 22 45

  • 세부 내용 추가
    스크린샷 2020-08-18 오후 9 09 05

  • 추가 완료
    스크린샷 2020-08-18 오전 8 20 56

  • Environment 애서 Dahaeng-DEV 선택

  1. json 등록

DAHAENG_API_documentation.postman_collection.json.zip

이 zip file 의 압축을 풀면 ~~~.json 이 생성이 됩니다.

그후 아래와 같이 처리를 하게 된다면,

스크린샷 2020-08-18 오전 8 27 12

아래와 같이, API 문서가 생성이 된것을 볼수 있습니다.

스크린샷 2020-08-18 오전 8 33 56

  1. 세부적인 결과 확인
    아래 와 같이, 세부적으로 내용을 확인을 할 수 있습니다.
    또한, 저기 표시를 해둔 것을 클릭 할 경우, 이전의 Response 의 결과를 확인을 할 수 있습니다.

스크린샷 2020-08-18 오후 9 09 47

  • 추후 보완해야하는 점
    API Documentation 새로 만들때마다 올리기
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@heojae