一、导包:
包的版本不要超过2.8.0,因为高版本的包会出现一些问题
<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>
二、配置swagger2的配置文件:
要注意在代码中配置controller的路径.
package com.cfets.autoGuide.common; 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.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket;
@EnableSwagger2 @Configuration public class Swagger2 { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()
// 这里是配置swagger生效的controller .apis(RequestHandlerSelectors.basePackage("com.cfets.autoGuide.controller")) .paths(PathSelectors.any()) .build(); } @Bean public ApiInfo apiInfo() { return new ApiInfoBuilder() .title("标题") .description("描述") .termsOfServiceUrl("") .version("1.0") .build(); } }
三、测试
启动项目
浏览器输入:http://localhost:8080/swagger-ui.html 就能看到controller生成的接口文档了
此处在controller的方法和类上面没有加相关注解,我个人认为对代码的侵入性比较大,有兴趣的同学可以研究研究swagger-ui的注解