SpringMVC和Swagger整合方法
描述
Swagger 是一個(gè)規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)。
總體目標(biāo)是使客戶端和文件系統(tǒng)作為服務(wù)器以同樣的速度來(lái)更新。文件的方法、參數(shù)和模型緊密集成到服務(wù)器端的代碼，允許 API 來(lái)始終保持同步。Swagger 讓部署管理和使用功能強(qiáng)大的 API 從未如此簡(jiǎn)單。
配置
1、引入相關(guān)jar包：
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency>
2、創(chuàng)建java配置類
@Configuration
@EnableSwagger2
public class Swagger2 {
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 文檔標(biāo)題
.title("wish")
// 文檔描述
.description("https://github.com/handexing").termsOfServiceUrl("https://github.com/handexing")
.version("v1")
.build();
}
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// 指定controller存放的目錄路徑
.apis(RequestHandlerSelectors.basePackage("com.wish.controller"))
.paths(PathSelectors.any())
.build();
}
}
3、編寫(xiě)接口文檔測(cè)試
@RequestMapping(value = "testSawgger", method = RequestMethod.POST, produces = "application/json; charset=utf-8")
@ApiOperation(value = "測(cè)試swagger", httpMethod = "POST", notes = "testSawgger")
public ExecuteResult<Boolean> addUser(@ApiParam(value = "參數(shù)", required = true) Long id) {
ExecuteResult<Boolean> result = new ExecuteResult<Boolean>();
try {
result.setSuccess(true);
} catch (Exception e) {
result.setSuccess(false);
}
return result;
}
說(shuō)明：
@ApiOperation:用在方法之上
1、value: 表示接口名稱
2、notes: 表示接口詳細(xì)描述
3、httpMethod:表示接口請(qǐng)求方法類型
@ApiParam:用在方法參數(shù)上
1、required:表示參數(shù)是否必須傳
2、name:表示參數(shù)名稱
3、value:表示參數(shù)描述
測(cè)試
swagger2文檔的默認(rèn)地址是 /swagger-ui.html, 本地開(kāi)發(fā)的訪問(wèn)http://localhost:8080/swagger-ui.html就可以看到自動(dòng)生成的文檔了
結(jié)語(yǔ)
到這就配置好了，最終demo可查看 源碼地址
總結(jié)
以上所述是小編給大家介紹的SpringMVC和Swagger整合方法，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！
- springMVC利用FastJson接口返回json數(shù)據(jù)相關(guān)配置詳解
- springmvc fastjson 反序列化時(shí)間格式化方法(推薦)
- 詳解在springmvc中解決FastJson循環(huán)引用的問(wèn)題
- Spring MVC集成springfox-swagger2構(gòu)建restful API的方法詳解
- SpringMVC集成Swagger實(shí)例代碼
- Spring MVC利用Swagger2如何構(gòu)建動(dòng)態(tài)RESTful API詳解
- SpringMVC如何在生產(chǎn)環(huán)境禁用Swagger的方法
- SpringMVC 中配置 Swagger 插件的教程(分享)
- Spring MVC+FastJson+Swagger集成的完整實(shí)例教程
相關(guān)文章
這篇文章主要介紹了完美解決idea突然間很卡的問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2021-02-02
怎樣提高mybatis-plus中saveBatch方法的效率
這篇文章主要介紹了怎樣提高mybatis-plus中saveBatch方法的效率問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-07-07
JAVA技術(shù)實(shí)現(xiàn)上傳下載文件到FTP服務(wù)器(完整)
這篇文章主要介紹了JAVA技術(shù)實(shí)現(xiàn)上傳下載文件到FTP服務(wù)器(完整)，本文使用 Apache Jakarta Commons Net（commons-net-3.3.jar） 基于FileZilla Server服務(wù)器實(shí)現(xiàn)FTP服務(wù)器上文件的上傳/下載/刪除等操作,需要的朋友可以參考下2015-07-07
MybatisPlus多表連接查詢的具體實(shí)現(xiàn)
MyBatis Plus是一款針對(duì)MyBatis框架的增強(qiáng)工具, 它提供了很多方便的方法來(lái)實(shí)現(xiàn)多表聯(lián)查,本文主要介紹了MybatisPlus多表連接查詢的具體實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下2023-10-10
這篇文章主要介紹了Java圓柱體表面積和體積計(jì)算代碼實(shí)例,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-06-06
Java 有能力從類路徑中查找獲取資源，可將資源放在 CLASSPATH 里，也可打包到 Jar 中。本文將具體講述獲取資源的步驟，感興趣的朋友可以了解下2021-05-05
從鍵盤(pán)上輸入一個(gè)字符串，遍歷該字符串中的每個(gè)字符，若該字符為小寫(xiě)字母，則輸出“此字符是小寫(xiě)字母”；若為大寫(xiě)字母，則輸出“此字符為大寫(xiě)字母”；否則輸出“此字符不是字母”2013-09-09
個(gè)人從來(lái)沒(méi)有研究過(guò)圖像學(xué)，也沒(méi)看過(guò)什么論文或者相關(guān)文檔，寫(xiě)這個(gè)完全是靠google和百度，自己寫(xiě)了個(gè)實(shí)驗(yàn)了下，測(cè)試用例也少，估計(jì)有大BUG的存在，所以看的人權(quán)當(dāng)學(xué)習(xí)交流，切勿生產(chǎn)使用。2014-09-09
簡(jiǎn)單易用的Spring?Boot郵件發(fā)送demo
本文將介紹如何使用Spring?Boot發(fā)送郵件,我們將演示如何配置SMTP郵件服務(wù)器,創(chuàng)建一個(gè)郵件模板,以及如何使用JavaMailSender發(fā)送郵件,我們還將介紹如何測(cè)試我們的郵件發(fā)送代碼2023-12-12
java UDP實(shí)現(xiàn)一個(gè)聊天工具的示例代碼
這篇文章主要介紹了java UDP實(shí)現(xiàn)一個(gè)聊天工具的示例代碼,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-01-01