一. Swagger是什么？

Swagger是一款RESTFUL接口的文檔在線自動(dòng)生成+功能測(cè)試功能軟件。

Swagger是一個(gè)規(guī)范和完整的框架,用于生成、描述、調(diào)用和可視化RESTful風(fēng)格的Web服務(wù)。

swagger是一款可以根據(jù)resutful風(fēng)格生成的生成的接口開發(fā)文檔，并且支持做測(cè)試的一款中間軟件

二：為什么要使用swaager?

2.1:對(duì)于后端開發(fā)人員來說

不用再手寫WiKi接口拼大量的參數(shù)，避免手寫錯(cuò)誤

對(duì)代碼侵入性低，采用全注解的方式，開發(fā)簡(jiǎn)單

方法參數(shù)名修改、增加、減少參數(shù)都可以直接生效，不用手動(dòng)維護(hù)

缺點(diǎn)：增加了開發(fā)成本，寫接口還得再寫一套參數(shù)配置

2.2:對(duì)于前端開發(fā)來說

后端只需要定義好接口，會(huì)自動(dòng)生成文檔，接口功能、參數(shù)一目了然

聯(lián)調(diào)方便，如果出問題，直接測(cè)試接口，實(shí)時(shí)檢查參數(shù)和返回值,就可以快速定位是前端還是后端的問題

2.3：對(duì)于測(cè)試

對(duì)于某些沒有前端界面UI的功能，可以用它來測(cè)試接口

操作簡(jiǎn)單，不用了解具體代碼就可以操作

三? :Swagger 解決了什么？

四：spring boot 集成 Swagger

4.1 ： pom文件引入Swagger依賴 如下

io.springfox

springfox-swagger2

2.7.0

io.springfox

springfox-swagger-ui

2.7.0

4.2 ：編寫Swagger的配置啟動(dòng)類,此類與springboot的啟動(dòng)類同級(jí)目錄

Swagger啟動(dòng)類代碼如下? 啟動(dòng)類中一定要配好掃描的contorller的全路徑

/*** swagger2的配置文件

*http://localhost:30001/swagger-ui.html

*@authorsongbin

* @date 2019/5/28 15:37*/@Configuration

@EnableSwagger2public classSwagger2 {/*** 配置swagger2的一些基本的內(nèi)容，比如掃描的包等等

*@return

*/@BeanpublicDocket createRestApi(){return newDocket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.ztqm.power.controller"))

.paths(PathSelectors.any())

.build();

}/*** 構(gòu)建 api文檔的詳細(xì)信息函數(shù)

*@return

*/

privateApiInfo apiInfo() {return newApiInfoBuilder()//頁面標(biāo)題

.title("Welcome to Swagger2")//創(chuàng)建人

.contact(new Contact("SongBin", "", "282044525@qq.com"))//版本號(hào)

.version("1.0")//描述

.description("您好 這里是 ：Swagger2的API文檔")

.build();

}

}

View Code

五：書寫Controller層 加入注解

/*** 網(wǎng)管實(shí)時(shí)報(bào)警表 添加操作

*@paramdeviceAlarmProperty

*@return

*/@ApiOperation(value= "添加 網(wǎng)管實(shí)時(shí)報(bào)警信息",notes = "根據(jù)DeviceAlarmProperty對(duì)象創(chuàng)建網(wǎng)管實(shí)時(shí)報(bào)警信息")

@ApiImplicitParam(name= "deviceAlarmProperty",dataType = "DeviceAlarmProperty",value = "網(wǎng)管實(shí)時(shí)報(bào)警信息實(shí)體DeviceAlarmProperty")

@RequestMapping(value= "/insert",method =RequestMethod.POST)publicJsonUtil insert(DeviceAlarmProperty deviceAlarmProperty){int num =deviceAlarmPropertyService.insert(deviceAlarmProperty);//如果對(duì)象不為空 則重新賦默認(rèn)值 code 1 ; msg 成功

if(null !=jsonUtil){

jsonUtil=JsonUtil.getJsonUtil();

}if(num==0){

jsonUtil=JsonUtil.getError();

}returnjsonUtil;

}

View Code

六：訪問?http://localhost:端口號(hào)/swagger-ui.html

點(diǎn)擊任意鏈接可以進(jìn)行測(cè)試

總結(jié)

以上是生活随笔為你收集整理的swaagerui2 与guava_Swagger使用总结的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。