重慶分公司
重慶分公司，新征程啟航
為企業(yè)提供網(wǎng)站建設(shè)、域名注冊(cè)、服務(wù)器等服務(wù)
SpringBoot整合swagger實(shí)現(xiàn)測(cè)試Restful風(fēng)格api-創(chuàng)新互聯(lián)
這篇文章運(yùn)用了實(shí)例代碼展示SpringBoot整合swagger實(shí)現(xiàn)測(cè)試Restful風(fēng)格api的步驟，代碼非常詳細(xì)，可供感興趣的小伙伴們參考借鑒，希望對(duì)大家有所幫助。
成都創(chuàng)新互聯(lián)公司是專(zhuān)業(yè)的道縣網(wǎng)站建設(shè)公司，道縣接單;提供網(wǎng)站設(shè)計(jì)、成都網(wǎng)站制作,網(wǎng)頁(yè)設(shè)計(jì),網(wǎng)站設(shè)計(jì),建網(wǎng)站,PHP網(wǎng)站建設(shè)等專(zhuān)業(yè)做網(wǎng)站服務(wù);采用PHP框架,可快速的進(jìn)行道縣網(wǎng)站開(kāi)發(fā)網(wǎng)頁(yè)制作和功能擴(kuò)展;專(zhuān)業(yè)做搜索引擎喜愛(ài)的網(wǎng)站,專(zhuān)業(yè)的做網(wǎng)站團(tuán)隊(duì),希望更多企業(yè)前來(lái)合作!一.Restful 風(fēng)格API
restful API 命名禁止出現(xiàn)動(dòng)詞，即用請(qǐng)求方式區(qū)分動(dòng)作。如下：
get 查詢(xún)接口
post 新增接口
put 更新接口
delete 刪除接口1.maven-archetype-quickstart方式創(chuàng)建模塊springboot-restful-api
2.把springboot-ssm模塊的代碼和配置復(fù)制過(guò)來(lái),不需要額外引入依賴(lài)。
3.修改UserController代碼，改成Restful接口
@RestController
@RequestMapping("/user")
public class UserController {
@Resource
private UserMapper userMapper;
//@RequestMapping("/listByUser")
@GetMapping("/")
public List listByUser() {
return userMapper.list();
}
//@RequestMapping("/getOneUser")
@GetMapping("/{id}")
public User getOneUser(@PathVariable("id") int id) {
return userMapper.selectByPrimaryKey(id);
}
//@RequestMapping("/addUser")
@PostMapping("/")
public int addUser(User user) {
return userMapper.insert(user);
}
//@RequestMapping("/deleteUser")
@DeleteMapping("/{id}")
public int deleteUser(@PathVariable("id") int id) {
return userMapper.deleteByPrimaryKey(id);
}
@PutMapping("/")
public int updateUser(User user) {
return userMapper.updateByPrimaryKey(user);
}
} 4.運(yùn)行測(cè)試，瀏覽器 http://localhost:8090/user/1
5.引入restful 風(fēng)格api后，post put delete請(qǐng)求方式在瀏覽器就不好操作了，此時(shí)我們可以選擇下載一個(gè)測(cè)試工具Postman來(lái)輔助我們測(cè)試。但SpringBoot可以集成一個(gè)很強(qiáng)大的測(cè)試工具，可以很方便的測(cè)試接口。它就是傳說(shuō)中的Swagger
二.SpringBoot 集成Swagger
1.引入依賴(lài)
io.springfox
springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2
2.創(chuàng)建配置類(lèi)SwaggerConfig.java
.apis(RequestHandlerSelectors.basePackage("xyz.java1024.controller")) 對(duì)應(yīng)controller所處的包
### 3.瀏覽器進(jìn)入api頁(yè)面 地址為：http://localhost:8090/swagger-ui.html
### 4.調(diào)用get請(qǐng)求接口
### 5.對(duì)于實(shí)體類(lèi)型的請(qǐng)求參數(shù)體，我們?cè)贑ontroller接口加上@RequestBody 可讀性會(huì)更加好！
> 修改前
> 修改后
//@RequestMapping("/addUser")
@PostMapping("/")
public int addUser(@RequestBody User user) {
return userMapper.insert(user);
}> 重新啟動(dòng)刷新swagger-ui頁(yè)面
### 5.測(cè)試post請(qǐng)求
> 把創(chuàng)建時(shí)間和更新時(shí)間參數(shù)去掉 ,填寫(xiě)用戶(hù)名等參數(shù)，成功插入一條數(shù)據(jù)。
### 6.swagger 增強(qiáng)
> 對(duì)于實(shí)體的某些屬性我們時(shí)不需要傳的，并且我們不想它顯示在swagger的請(qǐng)求體中，如 新增用戶(hù)的 createdAt和updatedAt 等屬性，我們可以通過(guò)在屬性上面添加@ApiModelProperty(hidden = true)注解來(lái)隱藏屬性public class User implements Serializable {
private int id;private String username; private String tel; private String password; private int status; @ApiModelProperty(hidden = true) private Timestamp createdAt; @ApiModelProperty(hidden = true) private Timestamp updatedAt;
> 此時(shí)重啟刷新swagger頁(yè)面，再次進(jìn)入U(xiǎn)serController的post可看到少了參數(shù)，如圖參數(shù)變得相當(dāng)簡(jiǎn)潔！
以上就是SpringBoot整合swagger實(shí)現(xiàn)測(cè)試Restful風(fēng)格api的方法介紹，詳細(xì)使用情況還得要大家自己使用過(guò)才能知道具體要領(lǐng)。如果想閱讀更多相關(guān)內(nèi)容的文章，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道！
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn，海內(nèi)外云服務(wù)器15元起步，三天無(wú)理由+7*72小時(shí)售后在線(xiàn)，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性?xún)r(jià)比高”等特點(diǎn)與優(yōu)勢(shì)，專(zhuān)為企業(yè)上云打造定制，能夠滿(mǎn)足用戶(hù)豐富、多元化的應(yīng)用場(chǎng)景需求。
新聞名稱(chēng)：SpringBoot整合swagger實(shí)現(xiàn)測(cè)試Restful風(fēng)格api-創(chuàng)新互聯(lián)
分享網(wǎng)址：http://news.spvevtbd.cn/article/cdphgi.html