Spring MVC集成springfox-swagger2構(gòu)建restful API的方法詳解
前言
在集成springfox-swagger2之前,我也嘗試著集成了swagger-springmvc,方式差不多,但是swagger-springmvc相對(duì)麻煩一點(diǎn),因?yàn)橐阉撵o態(tài)文件copy到自己的項(xiàng)目中。所以還是用新版本的。
至于兩者有什么不同,為什么進(jìn)行版本變更請(qǐng)參見(jiàn)官方說(shuō)明文檔
方法如下
這里先寫(xiě)下需要的pom.xml配置(我引用的2.4.0,相對(duì)穩(wěn)定)
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency>
還需要在spring-mvc.xml中添加映射靜態(tài)的配置:
<mvc:default-servlet-handler />
然后就是swagger2的配置類:
package com.xingguo.logistics.swagger; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket buildDocket(){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(buildApiInf()) .select() .apis(RequestHandlerSelectors.basePackage("com.xingguo.logistics.controller"))//controller路徑 .paths(PathSelectors.any()) .build(); } private ApiInfo buildApiInf(){ return new ApiInfoBuilder() .title("xingguo大標(biāo)題") .termsOfServiceUrl("http://blog.csdn.net/u014231523網(wǎng)址鏈接") .description("springmvc swagger2") .contact(new Contact("diaoxingguo", "http://blog.csdn.net/u014231523", "diaoxingguo@163.com")) .build(); } }
然后運(yùn)行項(xiàng)目,輸入自己的url。
http://{ip}:{port}/{projectname}/swagger-ui.html#/
我的url:
http://localhost:8989/logistics/swagger-ui.html#/
然后就可以看到效果圖:
它會(huì)把按照controller,把所有的接口都加載進(jìn)來(lái)。
我的目錄結(jié)構(gòu)如圖:
然后,就是接口名稱和參數(shù)的說(shuō)明:
常用注解:
- @Api()
用于類名
- @ApiOperation()
用于方法名
- @ApiParam()
用于參數(shù)說(shuō)明
- @ApiModel()
用于實(shí)體類
- @ApiModelProperty
用于實(shí)體類屬性
更詳細(xì)的說(shuō)明請(qǐng)參見(jiàn)官方注解說(shuō)明文檔
使用方法如圖:
@Controller //類上使用@Api @Api(value="用戶controller",description="用戶相關(guān)操作") public class UserController { @RequestMapping(value="index",method=RequestMethod.POST) //方法上使用@ApiOperation @ApiOperation(value="首頁(yè)",notes="跳轉(zhuǎn)到首頁(yè)") //參數(shù)使用@ApiParam public Object getIndex(@ApiParam(name="topic實(shí)體",value="json格式",required=true) @RequestBody Topic topic){ //業(yè)務(wù)內(nèi)容,被我刪除了,請(qǐng)忽略,主要看上面的注解 Object obj = new Object(); return obj; } }
//一般添加個(gè)@ApiModel()就可以,看情況使用里面的屬性 @ApiModel(value="Topic", discriminator = "foo", subTypes = {Topic.class}) public class Topic{ }
效果圖如下:
我在springboot中也集成了swagger2,集成方式基本相同,使用方式也基本一樣。請(qǐng)參考Spring Boot集成springfox-swagger2構(gòu)建restful API的方法教程
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來(lái)一定的幫助,如有疑問(wèn)大家可以留言交流,謝謝大家對(duì)腳本之家的支持。
相關(guān)文章
SpringCloud學(xué)習(xí)筆記之Feign遠(yuǎn)程調(diào)用
Feign是一個(gè)聲明式的http客戶端。其作用就是幫助我們優(yōu)雅的實(shí)現(xiàn)http請(qǐng)求的發(fā)送。本文將具體為大家介紹一下Feign的遠(yuǎn)程調(diào)用,感興趣的可以了解一下2021-12-12Spring?Boot實(shí)現(xiàn)消息的發(fā)送和接收使用實(shí)戰(zhàn)指南
這篇文章主要為大家介紹了Spring?Boot實(shí)現(xiàn)消息的發(fā)送和接收使用實(shí)戰(zhàn)指南,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-06-06Java8函數(shù)式接口java.util.function速查大全
因?yàn)镴ava8引入了函數(shù)式接口,在java.util.function包含了幾大類函數(shù)式接口聲明,這篇文章主要給大家介紹了關(guān)于Java8函數(shù)式接口java.util.function速查的相關(guān)資料,需要的朋友可以參考下2021-08-08Java?將list集合數(shù)據(jù)按照時(shí)間字段排序的方法
這篇文章主要介紹了Java?將list集合數(shù)據(jù)按照時(shí)間字段排序,本文通過(guò)示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-03-03Java異步調(diào)用轉(zhuǎn)同步方法實(shí)例詳解
這篇文章主要介紹了Java異步調(diào)用轉(zhuǎn)同步方法實(shí)例詳解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-06-06JAVA?GUI基礎(chǔ)與MouseListener用法
這篇文章主要介紹了JAVA?GUI基礎(chǔ)與MouseListener用法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12Maven一鍵部署Springboot到Docker倉(cāng)庫(kù)為自動(dòng)化做準(zhǔn)備(推薦)
這篇文章主要介紹了Maven一鍵部署Springboot到Docker倉(cāng)庫(kù),本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-07-07