티스토리 뷰

Tools

API 문서화 도구 Swagger v2 사용법

VoidNoble 공허공자 2016.08.02 17:30

https://github.com/swagger-api/swagger-ui/releases
에서 압축파일 받아 원하는 경로에 압축 해제

https://github.com/swagger-api/swagger-ui
설명 훑어보기로 감상

http://swagger.io/swagger-ui/
에서 명령하는대로만 하면 안되고 스마트하게 아래와 같이 콘솔에서 명령

npm install
gulp serve

브라우저에서 localhost:8080 접속

해보면 로컬에서 Swagger 문서 페이지가 보일것임.

당연히 ./dist/ 폴더 하위 전체를 웹서버에 올리면 인터넷에 API 문서 공개 가능.

이제 입맛에 맞게 수정해봐야 할 차례

http://editor.swagger.io
자신의 API 환경에 맞게 문서 수정

수정을 완료하였으면
File -> Download YAML

다운받은 yaml 파일을
로컬 Swagger/dist/ 로 이동

로컬 Swagger/dist/index.html 파일을 텍스트 편집기로 열고 아래와 같이 수정

$(function () {
   var url = window.location.search.match(/url=([^&]+)/);
   if (url && url.length > 1) {
     url = decodeURIComponent(url[1]);
   } else {
    //- url = "http://petstore.swagger.io/v2/swagger.json";
     url = "swagger.yaml";
   }

브라우저로 돌아가서
업데이트된 페이지 확인

만약 업데이트 안되었다면
브라우저 새로고침 한번 해보기

 

참고= http://idratherbewriting.com/pubapis_swagger/

댓글
댓글쓰기 폼
Total
715,672
Today
18
Yesterday
608
«   2018/12   »
            1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31          
글 보관함