logo
0
0
WeChat Login
docs: 补充英文文档

golang-swag

Convert golang comments to swagger2.0 API documentation.

Usage with Docker

docker run --rm -it -v $(pwd):$(pwd) -w $(pwd) \ --entrypoint="" \ tencentcom/golang-swag \ swag -h
docker run --rm -it -v $(pwd):$(pwd) -w $(pwd) \ -e PLUGIN_DIR="./" \ -e PLUGIN_EXTRA_ARGS="--parseDependency --parseDepth 3" \ tencentcom/golang-swag

Usage with Cloud Native Build

main: push: - stages: - name: Generate swagger documentation image: tencentcom/golang-swag settings: dir: ./ extra_args: --parseDependency --parseDepth 3
main: push: - stages: - name: Generate swagger documentation image: tencentcom/golang-swag commands: | swag -h swag init

More Usage

Refer to swaggo/swag