在上一节,我们完成了一个服务端同时支持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 [image] OpenAPI规范 OpenAPI规范是Linux基金会的一个项目,试图通过定义一种用来描述API格式或API定义的语言,来规范RESTful服务开发过程。OpenAPI规范帮助我们描述一个API的基本信息,比如: 有关该API的一般性描述 可用路径(/资源) 在每个路径上的可用操作(获取/提交…) 每个操作的输入/输出格式 目前V2.