Go语言中文网,致力于每日分享编码、开源等知识,欢迎关注我,会有意想不到的收获!
在上一节grpc-gateway 系列2:Hello World,我们完成了一个服务端同时支持Rpc和RESTful Api后,你以为自己大功告成了,结果突然发现要写Api文档和前端同事对接= = 。。。
你寻思有没有什么组件能够自动化生成Api文档来解决这个问题,就在这时你发现了Swagger,一起了解一下吧!
介绍
Swagger
Swagger是全球最大的OpenAPI规范(OAS)API开发工具框架,支持从设计和文档到测试和部署的整个API生命周期的开发
Swagger是目前最受欢迎的RESTful Api文档生成工具之一,主要的原因如下
- 跨平台、跨语言的支持
- 强大的社区
- 生态圈 Swagger Tools(Swagger Editor、Swagger Codegen、Swagger UI ...)
- 强大的控制台
同时grpc-gateway也支持Swagger
![fdc0b037e09fd77a1f24f763fc17cfe6.png](https://i-blog.csdnimg.cn/blog_migrate/ca9c0656c47d31aaa38d656cdb3a07df.jpeg)
OpenAPI规范
OpenAPI规范是Linux基金会的一个项目,试图通过定义一种用来描