一、swagger介绍

• 前后端分离开发模式中，api文档是最好的沟通方式。
• Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
  • 及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
  • 规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
  • 一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
  • 可测性 (直接在接口文档上进行测试，以方便理解业务)

二、具体整合过程

1、在父工程下新建一个子模块conmon，引入相关依赖

2、在conmon模块下新建子模块service_base,在service_base下面写swagger配置类

package com.yamky.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;

/**
 * @author yamky
 * @create 2021-05-09 9:51
 */

@Configuration //配置类
@EnableSwagger2 //swagger注解
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("lesiApi")
                .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("yamky", "", "1482780155@qq.com"))
                .build();
    }
}

3、具体使用，在service_edu引入service_base依赖

4、最后在service_edu启动类添加注解，设置包扫描规则

5、最后访问http://localhost:8001/swagger-ui.html，如果出现如图所示界面表示整合成功。