一、添加依賴
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency>
二、添加類
@EnableWebMvc @EnableSwagger2 @Configuration public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.z*.b*.c*.controller")) // 注意修改此處的包名 .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("接口列表 v1.1.0") // 任意,請稍微規范點 .description("接口測試") // 任意,請稍微規范點 .termsOfServiceUrl("http://url/swagger-ui.html") // 將“url”換成自己的ip:port .contact("laowu") // 無所謂(這里是作者的別稱) .version("1.1.0") .build(); } }
三、在spring-mvc.xml中添加
<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/> <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>
四、類、方法上添加注解
@ApiOperation(value = "名稱", httpMethod = "POST") @ApiParam(required = true, name = "test", value = "參數")
五、訪問 localhost:8080/項目名/swagger-ui.html
六、添加攔截過濾
<mvc:exclude-mapping path="/swagger*/**"></mvc:exclude-mapping> <mvc:exclude-mapping path="/v2/**"></mvc:exclude-mapping> <mvc:exclude-mapping path="/webjars/**"></mvc:exclude-mapping>
轉自:http://www.jb51.net/article/130208.htm