swagger是个什么东西
swagger是一个简单但功能强大的API表达工具。几乎所有的现代编程语言,都在支持和使用Swagger。使用它生成API,我们即得到交互式文档,也可以自动生成代码的SDK等
相关工具
背景
由于项目要求,后端接口需要提供接口文档给前端,另外项目是用golang写的;经过百度后发现go-swagger,swagger-editor满足相关需求
工具
swagger-editor:用于编写swagger文档工具,并实时生成相关UI展示,实现所见即所得。具体介绍见官方文档
go-swagger:用于生成和实现自定一swagger后端
项目(api-ms)介绍
1、clone代码到本地
git clone https://github.com/hrf304/api-ms.git
2、编译并运行
go build & ./api-ms
3、在浏览器访问地址:
http://localhost:8081/swagger/index.html?project=swagger
其中:swagger为files下面对应文件的文件名
效果如下: