[Go] swaggo

swaggo는 swagger 생성용 모듈이다.
comment 기반으로 generate를 해주는 도구다.

설치

먼저 CLI 도구를 설치한다.

go get -d github.com/swaggo/swag/cmd/swag

그래서 이렇게 실행이 되면 된다.

기본 사용법

아래와 같이 주석 기반으로 각 API에 대한 명세를 정의해준다.

그리고 swag cli로 루트경로에서 다음과 같은 형태로, 진입점을 경로로 줘서 생성을 명령한다.

그러면 doc 경로에 결과물을 내뱉는다.

이걸 이제 echo, gin, fiber 등 웹프레임워크들을 통해 서빙해주거나 하면 된다.