在Go API中生成空的Swagger规范

一分耕耘，一分收获！既然都打开这篇《在Go API中生成空的Swagger规范》，就坚持看下去，学下去吧！本文主要会给大家讲到等等知识点，如果大家对本文有好的建议或者看到有不足之处，非常欢迎大家积极提出！在后续文章我会继续更新Golang相关的内容，希望对大家都有所帮助！

我正在尝试使用我的 api 处理程序生成 swagger 规范。

我已经从 go get 安装了 go-swagger：

go get -u github.com/go-swagger/go-swagger/cmd/swagger

请参阅下面的项目结构：

main.go 使用 products.go 中的处理程序定义。 （api 有效并经过测试）

product.go 中的 swagger 规范：

// package classification of product api.
//
// documenting for product api
//
//
//
// schemes: http, https
// basepath: /
// version: 0.0.1
//
// consumes:
// - application/json
//
// produces:
// - application/json
//
// swagger:meta

从 main.go 路径运行以下命令：

go111module=off swagger generate spec -o ./swagger.yaml --scan-models

回应：

info: {}
paths: {}
swagger: "2.0"

预期响应：

basePath: /
consumes:
- application/json
info:
  description: Documenting for Product API
  title: 
  version: 0.0.1
paths: {}
producrs:
- application/json
schemes:
- http
swagger: "2.0"

解决方案

我假设您正在关注 nic 的 MSA Go tutorial。

如果您还没有弄清楚问题所在，您可能忘记为内容添加空格。 （第一行和最后一行之间的线）

您的文档注释应如下所示

// Documentation for Product API
//
//  Schemes: http
//  BasePath: /
//  Version: 1.0.0
//
//  Consumes:
//  - application/json
//
//  Produces:
//  - application/json
//
// swagger:meta

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于Golang的相关知识，也可关注golang学习网公众号。