最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

Spring MVC集成springfox-swagger2構(gòu)建restful API的方法詳解

 更新時(shí)間:2017年06月13日 11:31:15   作者:興國(guó)First  
這篇文章主要給大家介紹了關(guān)于Spring MVC集成springfox-swagger2構(gòu)建restful API的相關(guān)資料,文中介紹介紹的非常詳細(xì),需要的朋友可以參考借鑒,下面來(lái)一起看看吧。

前言

在集成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的配置類(lèi):

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)如圖:

然后,就是接口名稱(chēng)和參數(shù)的說(shuō)明:

常用注解:

      - @Api()用于類(lèi)名

      - @ApiOperation()用于方法名

      - @ApiParam()用于參數(shù)說(shuō)明

      - @ApiModel()用于實(shí)體類(lèi)

      - @ApiModelProperty用于實(shí)體類(lèi)屬性

更詳細(xì)的說(shuō)明請(qǐng)參見(jiàn)官方注解說(shuō)明文檔

使用方法如圖:

@Controller
//類(lèi)上使用@Api
@Api(value="用戶(hù)controller",description="用戶(hù)相關(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)文章

最新評(píng)論

永仁县| 蓝田县| 兴安县| 太和县| 临桂县| 吉木萨尔县| 南城县| 海伦市| 那坡县| 兖州市| 土默特右旗| 康定县| 中宁县| 梨树县| 金堂县| 拜城县| 平顶山市| 贵溪市| 鸡泽县| 拜泉县| 德安县| 奇台县| 霍邱县| 渝中区| 吉林市| 济南市| 石泉县| 迁西县| 米泉市| 陈巴尔虎旗| 长岭县| 永丰县| 英山县| 元谋县| 白沙| 阜康市| 渝中区| 永新县| 杭州市| 新竹县| 延寿县|