swagger配置详解

Swagger配置类

//扫描controler，最好swagger和controler同目录
@ComponentScan(basePackages = {"com.lt.smart_barcelet_auth.controler"})
@Configuration
@EnableSwagger2
public class SwaggerConfig  {

	/**
	 * 通过createRestApi函数创建Docket的Bean之后，
	 * apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）
	 * select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，
	 * apis()函数扫描所有Controller中定义的API， 并产生文档内容（除了被@ApiIgnore指定的请求）
	 * @return
	 */
	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.any())
				.paths(PathSelectors.any())
				//不显示错误的接口地址
				.paths(Predicates.not(PathSelectors.regex("/error.*")))//错误路径不监控
				.paths(PathSelectors.regex("/.*"))// 对根下所有路径进行监控
				.build();
		
	}

	/**
	 * 创建该Api的基本信息（这些基本信息会展现在文档页面中）
	 * @return
	 */
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title(" app项目接口文档")
				.termsOfServiceUrl("www.baidu.com")
				.version("1.0")
				.build();
	}
}

参数详解

Spring boot - swagger整合依赖

   <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>