Development reference and Contributor WANTED!! (WIP)

Swagger 를 통한 API 자동 문서화 기능

https://github.com/cloud-barista/cb-tumblebug/pull/189

문서 자동 생성을 위해서는

echo-swagger 를 설치 후,

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

src/ 디렉토리에서

~/go/bin/swag init

또는 빌드시 swag 옵션을 추가하여 빌드함.

make swag

출력 예시

cb-user@ip-192-168-2-108:~/go/src/github.com/cloud-barista/cb-tumblebug/src$ ~/go/bin/swag init
2021/08/24 21:12:39 Generate swagger docs....
2021/08/24 21:12:39 Generate general API Info, search dir:./
2021/08/24 21:12:39 Generating common.ConfigInfo
2021/08/24 21:12:39 Generating common.SimpleMsg
...
2021/08/24 21:12:39 Generating mcis.PriorityCondition
2021/08/24 21:12:39 Generating mcis.ParameterKeyVal
2021/08/24 21:12:39 create docs.go at docs/docs.go
2021/08/24 21:12:39 create swagger.json at docs/swagger.json
2021/08/24 21:12:39 create swagger.yaml at docs/swagger.yaml

그 결과, docs/swagger.yaml 가 자동으로 생성됨.