使用swagger2生成RESTful客户端

swagger是一款高效易用的嵌入式文档插件,同时支持在线测试接口,快速生成客户端代码。

生成客户端代码,是swagger官方提供的功能,也就是swagger-editor 项目的职能。客户端在时间充足的情况下,最好还是自己写,必定自己写的代码更具有持续维护性。但是如果时间有限的情况下,使用它开发客户端调用程序,也不失是一种有效解决办法。

使用方法

①. 下载文档的描述json

运行引入swagger的spring-boot的项目,如果你还没有项目,可以点击这里,根据描述运行示例项目
访问下载地址,

 http://{服务启动主机地址}:{服务启动端口}/v2/api-docs?group={需要生成的api所属组name} 

,如果你运行的是示例项目,端口启动在8080端口上,需要下载‘01.user-api’组的的json文档描述,可以点击这里下载。

② 生成客户端代码

打开swagger-editor,点击页面左上角,‘file’->importFile->选择刚才下载的json文件上传-> 点击‘Generate Client’->‘点选你要生成的客户端语言’->等一下,会自动下载生成的客户端程序包

相关资源
spring-boot-starter-swagger git地址
swagger-editor
swagger

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章