Swagger整合

Swagger的作用

1. 生成在线接口文档
2. 接口测试

因为每个模块都需要使用这，所以我们建立一个公共的模块来管理

依赖

    
        project_parent
        com.atwjw
        0.0.1-SNAPSHOT
    
    4.0.0

    common
    pom
    
        server_base
        common_utils
        common_utils
    

    
        8
        8
    

    
        
            org.springframework.boot
            spring-boot-starter-web
            provided
          

        
            com.baomidou
            mybatis-plus-boot-starter
            provided
        

        
        
            org.projectlombok
            lombok
            provided
        

        
        
            io.springfox
            springfox-swagger2
            provided
        

        
            io.springfox
            springfox-swagger-ui
            provided
        

        
        
            org.springframework.boot
            spring-boot-starter-data-redis
        

    

配置类

package com.atwjw.servicebase;

import com.google.common.base.Predicates;
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.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//Swagger注解
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig() {
        return new Docket(documentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())//会显示文档中的一些值
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();

    }

    private ApiInfo webApiInfo() {
//        定义文档的一些信息
        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("Helen", "http://atwjw.com",
                        "@qq.com"))
                .build();
    }
}

最后一步改变包的扫描规则，SpringBoot需要管理到Swagger，我们需要对Swagger的配置类进行扫描需要在启动类上添加注解

//作为主程序的启动类
@SpringBootApplication
@ComponentScan(basePackages = {"com.atwjw"})//这个是为了扫描到配置类中、、、这个是修改启动了类的扫描规则，如果不修改只能扫描当前项目的类
public class EduApplication {//1、引入依赖2、改变扫描规则
    public static void main(String[] args) {
        SpringApplication.run(EduApplication.class,args);
    }
}