/**
 * @author :Administrator
 * @description :
 * @create :2021-10-22 22:28:00
 */
//注解开启 swagger2 功能
@EnableSwagger2
@Configuration
public class Swagger {
    /**
     * 通过 createRestApi函数来构建一个DocketBean
     * 函数名,可以随意命名,喜欢什么命名就什么命名
     */
    @Bean
    public Docket createRestApi() {
        //控制暴露出去的路径下的实例
        //如果某个接口不想暴露,可以使用以下注解
        //@ApiIgnore 这样,该接口就不会暴露在 swagger2 的页面下
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(true)
                .apiInfo(apiInfo()).select()  //调用apiInfo方法,创建一个ApiInfo实例,里面是展示在文档页面信息内容
    .apis(RequestHandlerSelectors.basePackage("com.xxx.xxx"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("xxx 接口文档")
                //创建人
                .contact("xxx")
                //版本号
                .version("1.0")
                //描述
                .description("xxx后台接口文档")
                .build();
    }
}

swagger:
  title: xxx
  description: xxx接口文档
  version: 1.0
  license: xxx
  license-url: xxxx
  terms-of-service-url: xxxx
  contact:
    name: xxxx
    url: xxxx
    email: xxxa
  base-package: com.xxx.xxx
  base-path: /**