SpringBoot2.0實戰(8)整合Swagger2自動生成API文檔

Swagger 是一個規範和完整的框架,用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。

相關知識

Swagger官網:https://swagger.io

常用註解:

@Api 用於類,表示標識這個類是swagger的資源

@ApiOperation 用於方法,表示一個http請求的操作

@ApiParam 用於方法,參數,字段說明,表示對參數的添加元數據(說明或是否必填等)

@ApiModel 用於類,表示對類進行說明,用於參數用實體類接收

@ApiModelProperty 用於方法,字段,表示對model屬性的說明或者數據操作更改

@ApiIgnore 用於類,方法,方法參數,表示這個方法或者類被忽略

@ApiImplicitParam 用於方法,表示單獨的請求參數

@ApiImplicitParams 用於方法,包含多個 @ApiImplicitParam

課程目標

在 第十章:SpringBoot整合MapStruct簡化參數映射 的代碼基礎上,整合 Swagger2 實現自動生成文檔

操作步驟

添加依賴

添加 Swagger2 的依賴

編碼

新建配置類

@Configuration 註解用於項目啓動時自動加載

@EnableSwagger2 註解用於開啓 swagger2

爲接口添加 swagger 註解

 

爲入參添加 swagger 註解

 

驗證結果

訪問 http:/localhost:8080/swagger-ui.html,即可看到 API 文檔

源碼地址

本章源碼 :https://github.com/caiyuanzi-song/boot.git

總結

Swagger 可以實時生成文檔,保證文檔的時效性,這有助於前後端聯合開發、微服務聯合開發等

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