liuyaqi 93de26f6e0 feature: swagger 添加对 map 的识别、忽略 .DS_Store 文件夹 2 years ago
..
favicon-16x16.png 0e4b2fbeb6 feature:添加 swagger 2 years ago
favicon-32x32.png 0e4b2fbeb6 feature:添加 swagger 2 years ago
index.html c67806463f 提交 2 years ago
oauth2-redirect.html 0e4b2fbeb6 feature:添加 swagger 2 years ago
readme.md 935e9b8ced feature:添加配置支持 swagger 请求不鉴权 2 years ago
swagger-ui-bundle.js 0e4b2fbeb6 feature:添加 swagger 2 years ago
swagger-ui-bundle.js.map 0e4b2fbeb6 feature:添加 swagger 2 years ago
swagger-ui-standalone-preset.js 0e4b2fbeb6 feature:添加 swagger 2 years ago
swagger-ui-standalone-preset.js.map 0e4b2fbeb6 feature:添加 swagger 2 years ago
swagger-ui.css 0e4b2fbeb6 feature:添加 swagger 2 years ago
swagger-ui.css.map 0e4b2fbeb6 feature:添加 swagger 2 years ago
swagger-ui.js 0e4b2fbeb6 feature:添加 swagger 2 years ago
swagger-ui.js.map 0e4b2fbeb6 feature:添加 swagger 2 years ago
swagger.bak.yml 2cd0d8f97f feature:添加自动生成 swagger 2 years ago
swagger.go 93de26f6e0 feature: swagger 添加对 map 的识别、忽略 .DS_Store 文件夹 2 years ago

readme.md

  • 在 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,不再做鉴权处理