前言
在集成springfox-swagger2之前，我也嘗試著集成了swagger-springmvc，方式差不多，但是swagger-springmvc相對麻煩一點，因為要把它的靜態文件copy到自己的項目中。所以還是用新版本的。
至於兩者有什麼不同，為什麼進行版本變更請參見官方說明文檔
方法如下
這裡先寫下需要的pom.xml配置（我引用的2.4.0，相對穩定）
<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中添加映射靜態的配置：
<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大標題")
.termsOfServiceUrl("http://blog.csdn.net/u014231523網址鏈接")
.description("springmvc swagger2")
.contact(new Contact("diaoxingguo", "http://blog.csdn.net/u014231523", "[email protected]"))
.build();
}
}
然後運行項目，輸入自己的url。
http://{ip}:{port}/{projectname}/swagger-ui.html#/
我的url:
http://localhost:8989/logistics/swagger-ui.html#/
然後就可以看到效果圖：
它會把按照controller,把所有的接口都加載進來。
我的目錄結構如圖：
然後，就是接口名稱和參數的說明：
常用注解：
- @Api()用於類名
- @ApiOperation()用於方法名
- @ApiParam()用於參數說明
- @ApiModel()用於實體類
- @ApiModelProperty用於實體類屬性
更詳細的說明請參見官方注解說明文檔
使用方法如圖：
@Controller
//類上使用@Api
@Api(value="用戶controller",description="用戶相關操作")
public class UserController {
@RequestMapping(value="index",method=RequestMethod.POST)
//方法上使用@ApiOperation
@ApiOperation(value="首頁",notes="跳轉到首頁")
//參數使用@ApiParam
public Object getIndex(@ApiParam(name="topic實體",value="json格式",required=true) @RequestBody Topic topic){
//業務內容，被我刪除了，請忽略，主要看上面的注解
Object obj = new Object();
return obj;
}
}
//一般添加個@ApiModel（）就可以，看情況使用裡面的屬性
@ApiModel(value="Topic", discriminator = "foo", subTypes = {Topic.class})
public class Topic{
}
效果圖如下：
我在springboot中也集成了swagger2，集成方式基本相同，使用方式也基本一樣。請參考Spring Boot集成springfox-swagger2構建restful API的方法教程
總結
以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作能帶來一定的幫助，如有疑問大家可以留言交流，謝謝大家對的支持。
