OpenAPI Swagger 使用
swagger-api插件提供了一系列swagger相关的API,以及相应的UI界面
安装
首先安装插件到项目中
使用
浏览器中访问服务的/q/swagger-ui/
路径即可打开Swagger UI
方式2: 使用protoc插件生成swagger.json文件
新建项目Makefile中已经默认集成了生成swagger.json的相关命令,这里也介绍下具体的使用方式
安装
生成
在项目根目录直接使用protoc命令,请注意修改命令最后的proto文件路径为实际路径
使用
上面的命令执行成功后,将在您的proto文件所在目录生成相应的swagger.json文件。 您可以将其导入任何支持OpenAPI规范的平台进行浏览,例如: