使用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

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