Ubuntu 20.04安装go swagger并导入yapi

2,001 阅读1分钟

1, 设置go环境

  • vim ~/.zshrc
    • export GOPATH=/home/hello/go
    • export GOBIN=/home/hello/go/bin
    • export PATH=$PATH:/home/hello/go/bin
  • source ~/.zshrc

2, 安装swagger

  • go get github.com/go-swagger/go-swagger
  • cd /home/hello/go/src/github.com/go-swagger/go-swagger
  • go install ./cmd/swagger
  • 进入自己的项目目录执行
    • swagger generate spec -o ./swagger.json
  • 启动swagger http服务
    • swagger serve -F=swagger /home/hello/go/cyy/swagger.json

go代码注释

// swagger:operation POST /user/addUser user addUser
// ---
// summary: 新增用户信息
// description: 用于系统用户的新增
// parameters:
// - name: username
//   in: body
//   description: 用户名
//   type: string
//   required: true
// - name: password
//   in: body
//   description: 密码  
//   type: string
//   required: true
// responses:
//   200: repoResp
//   400: badReq

// swagger:operaion [POST:请求方式(可以是GET\PUT\DELETE...)] [url:请求地址] [标签] [用于此端点的请求]  (你可以将最后两个理解为id 节点,用于标注地址)
// --- 这个部分下面是YAML格式的swagger规范.确保您的缩进是一致的和正确的
// summary: 标题
// description: 描述
// parametres:   下面是参数了
// - name: 参数名
    in: [header|body|query] 参数的位置
    description: 描述
    type: 类型
    required: 是否必须
// responses: 响应