[백엔드] API 명세서 배포하기 Swagger 활용

기존에는 노션을 활용해 API 문서를 정리했었는데, 너무 비효율적이었다. 

연주선배님이랑 저번에 밥먹을 때, 이야기 나눴던 스웨거가 생각나서, 이를 적용하기로결정. 기존에는 AWS에 서버를 올려놨었는데, 매달 나가는 비용 대비 개발 속도가 진행이 안돼서 현재는 내린상태이다.

 

실질적으로 발생하던 비용은  EC2가 돌아가는 것에 대한 비용만 나가고있었다. (하루 0.5달러였나..) 750 시간까지 무료였다. (프리티어)

 

아무튼,,, 다들 졸프, 수강신청, 여행 등으로 바쁜 시기라 개발 진척도가 안나가고 & 디자이너가 팀을 나가게되어 기존의 프엔 작업물을 사용하지 못하게되는 상황이 되어버려 연동에 시간이 걸릴 것 같아 서버를 내렸다.

 

기존에는 스웨거 배포된 서버로 접근가능하게 security 설정 열어놨었는데, 이제 불가능..해서... 방법을 찾았다.

 

 

 

Swagger 사용 설정 방법은 다른 블로그를 참고하세요! 이건 스웨거설정되어있는상태에서, 스웨거만 배포하는 글임.

 

 

0. 레포 클론하기

하단의 레포지토리에 들어가, `Use this template` 버튼(우상단)을 통해 레포지토리 생성.

Organization이라 한명만 수행하면 다른사람은 해당 단계를 진행할 필요 없음.

https://github.com/peter-evans/swagger-github-pages

GitHub - peter-evans/swagger-github-pages: How to host Swagger API documentation with GitHub Pages

 

->

git clone 레포링크

레포를 클론해줍니다.

Visual Studio Code등으로 열어주세요

 

 

0-1. 

이후 레포지토리의 `Settings -> Pages`에서 브랜치를 master로 선택,

경로를 /(root)로 선택한 후 Save로 저장한다. 

• `Settings -> Pages -> Branch는 master -> 경로는 /(root) -> Save`

 

 

1. 로컬에서 서버 실행

 

접속 : `http://localhost:8080/v3/api-docs` 

 

 JSON 문자열을 전체복사해준다.

 

2.  JSON -> yaml 변환

 

JSON -> yaml 변환하여 내용 전체 복사한다.

해당링크에서 변환 가능하다.

https://www.bairesdev.com/tools/json2yaml/

JSON to YAML Online Converter

 

3. 변환한 코드를 swagger.yaml에 붙여넣는다.

이후, 커밋&푸시해주면 다음 링크로 생성된다.

`https://{Organization-name}.github.io/{Repository-name}/`

 

 

참고한 블로그

https://jihyun-devstory.tistory.com/m/41