go-swagger安装及使用

GO语言学习教程
www.lsdcloud.com

go-swagger介绍

go-swagger 为社区带来了一套完整的，功能齐全的高性能API组件，可与Swagger API一起使用：服务器，客户端和数据模型。

• 根据标准规范生成服务器
• 从摇摇欲坠的规范生成客户端
• 支持jsonschema和swagger提供的大多数功能，包括多态
• 从带注释的go代码中生成标准规范
• 配合规范使用的其他工具
• 强大的定制功能，带有供应商扩展和可定制的模板
• 我们在代码生成方面的重点是生成惯用的,快速执行的代码,该代码可与golint,go vet等配合使用

1 代码下载

go-swagger源码地址下载

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

2 安装swagger

安装go-swagger，移动到下载的go-swagger包目录（应该是GOPATH/src/pkg/github.com/go-swagger,理解这个意思就好，路径不一定对）。

go install ./cmd/swagger

3 生成swagger.json

进入自己项目的根目录,根据swagger规范,创建 swagger.json规范文档

swagger generate spec -o ./swagger.json  

• 解释：generate生成，spec指规格的意思 -o，这个字母o的意思是：-output即输出 。
• 总的命令意思就是：swagger 生成 规格 -输出 输出的路径和文件。

4 启动swagger服务

启动一个http服务同时将json文档放入http://petstore.swagger.io 执行

swagger serve -F=swagger D:\go_project\src\kratos\docs\api.swagger.json

更多go-swagger使用请参考官网

GO语言学习教程
www.lsdcloud.com