SpringMVC和Swagger整合方法
描述
Swagger 是一個規(guī)范和完整的框架,用于生成、描述、調(diào)用和可視化 RESTful 風格的 Web 服務。
總體目標是使客戶端和文件系統(tǒng)作為服務器以同樣的速度來更新。文件的方法、參數(shù)和模型緊密集成到服務器端的代碼,允許 API 來始終保持同步。Swagger 讓部署管理和使用功能強大的 API 從未如此簡單。
配置
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() // 文檔標題 .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、編寫接口文檔測試
@RequestMapping(value = "testSawgger", method = RequestMethod.POST, produces = "application/json; charset=utf-8") @ApiOperation(value = "測試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; }
說明:
@ApiOperation:用在方法之上
1、value: 表示接口名稱
2、notes: 表示接口詳細描述
3、httpMethod:表示接口請求方法類型
@ApiParam:用在方法參數(shù)上
1、required:表示參數(shù)是否必須傳
2、name:表示參數(shù)名稱
3、value:表示參數(shù)描述
測試
swagger2文檔的默認地址是 /swagger-ui.html, 本地開發(fā)的訪問http://localhost:8080/swagger-ui.html就可以看到自動生成的文檔了
結(jié)語
到這就配置好了,最終demo可查看 源碼地址
總結(jié)
以上所述是小編給大家介紹的SpringMVC和Swagger整合方法,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持!
- springMVC利用FastJson接口返回json數(shù)據(jù)相關(guān)配置詳解
- springmvc fastjson 反序列化時間格式化方法(推薦)
- 詳解在springmvc中解決FastJson循環(huán)引用的問題
- Spring MVC集成springfox-swagger2構(gòu)建restful API的方法詳解
- SpringMVC集成Swagger實例代碼
- Spring MVC利用Swagger2如何構(gòu)建動態(tài)RESTful API詳解
- SpringMVC如何在生產(chǎn)環(huán)境禁用Swagger的方法
- SpringMVC 中配置 Swagger 插件的教程(分享)
- Spring MVC+FastJson+Swagger集成的完整實例教程
相關(guān)文章
java實現(xiàn)頁面多查詢條件必選的統(tǒng)一處理思路
這篇文章主要為大家介紹了java實現(xiàn)頁面多查詢條件必選的統(tǒng)一處理思路詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-06-06Java詳細講解不同版本的接口語法和抽象類與接口的區(qū)別
對于面向?qū)ο缶幊虂碚f,抽象是它的一大特征之一,在?Java?中可以通過兩種形式來體現(xiàn)OOP的抽象:接口和抽象類,下面這篇文章主要給大家介紹了關(guān)于Java入門基礎(chǔ)之抽象類與接口的相關(guān)資料,需要的朋友可以參考下2022-04-04Spring使用Configuration注解管理bean的方式詳解
在Spring的世界里,Configuration注解就像是一位細心的園丁,它的主要職責是在這個繁花似錦的園子里,幫助我們聲明和管理各種各樣的bean,本文給大家介紹了在Spring中如何優(yōu)雅地管理你的bean,需要的朋友可以參考下2024-05-05Spring AOP有多少個通知以及它們的執(zhí)行順序介紹
這篇文章主要介紹了Spring AOP有多少個通知以及它們的執(zhí)行順序,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-11-11Java使用RedisTemplate操作Redis遇到的坑
這篇文章主要介紹了Java使用RedisTemplate操作Redis遇到的坑,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-12-12