SwaggerConfig

小鱼儿 2022-10-09 14:24 45阅读 0赞

package com.zyq.config;
    
    import java.util.ArrayList;
    import java.util.Collections;
    import java.util.List;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    import springfox.documentation.builders.ParameterBuilder;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.schema.ModelRef;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.service.Parameter;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
    
        @Bean
        public Docket docket() {
            List<Parameter> pars = new ArrayList<Parameter>();
            ParameterBuilder tokenPar = new ParameterBuilder();
            tokenPar.name("Authorization").description("授权令牌").modelRef(new ModelRef("string")).parameterType("header")
                    .required(false).build();
            pars.add(tokenPar.build());
            return new Docket(DocumentationType.SWAGGER_2)
                    /*
                     * 配置分组模块（比如在多人协同开发中，Jack负责订单模块，Marry负责用户模块，那么这里就可以设置为“订单模块”）
                     * 并且下面的扫描路径一般写为自己对应模块的包路径（如：com.zyq.controller.order），但如果需要设置多个分组，需要
                     * 配置多个生成Docket()的实例。
                     */
                    .groupName("默认模块")
                    // 配置swagger界面一些的自定义显示信息
                    .globalOperationParameters(pars).apiInfo(getApiInfo())
                    // 是否启动swagger？如果设置为false，则swagger接口文档将不能访问，通常线上的项目是会关闭的
                    .enable(true).select()
                    // 配置扫描的接口路径（常与上面groupName对应设置）
                    .apis(RequestHandlerSelectors.basePackage("com.zyq.controller")).build();
        }
    
        private ApiInfo getApiInfo() {
            String title = "Swagger接口文档";
            String description = "zyq的个人项目Swagger接口文档说明";
            String version = "v1.0";
            Contact contact = new Contact("", "", "");
            String license = "个人主页";
            String licenseUrl = "http://zyqok.cn/";
            ApiInfo apiInfo = new ApiInfo(title, description, version, "", contact, license, licenseUrl,
                    Collections.emptyList());
            return apiInfo;
        }
    
    }