logo
1
0
WeChat Login

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

About

golang版本 swagger api 文档生成插件

228.00 KiB
1 forks0 stars1 branches0 TagREADMEMIT license
Language
Markdown74%
License15.8%
Dockerfile5.5%
Shell4.7%