readme.md 682 B

  • 在 handler 中要生成文档的函数上,按照以下格式添加注释

    // Swagger:ServicePath tag1,tag2 接口名称

    例如

    // Swagger:CtrContract 合同 转移合同

  • 然后运行下面的命令生成 swagger.yml

    go run swaggerui/swagger.go -o swaggerui/swagger.yml

  • 在配置文件的 setting 中添加

    swagger = true

    启动服务即可在 18080 端口访问到 swagger 文档

  • 如果需要对使用 swaggerui 发出的请求做不鉴权处理,在配置文件的 setting 中添加

    fake-auth-for-swagger = true

    启用这个配置后,对所有请求直接设置了一个固定的 userinfo,不再做鉴权处理