义乌项目
blame | 历史 | 补丁 | 提交 | 提交对比 | ignore whitespace
wu
2024-04-29 f77c8f18ab49b54c9c0bd7c8cae4962912f792e4 
 hangzhoumesParent/common/servicebase/src/main/java/com/mes/common/config/Swagger2Config.java


New file


@@ -0,0 +1,93 @@


package com.mes.common.config;




import org.springframework.context.annotation.Bean;


import org.springframework.context.annotation.Configuration;


import springfox.documentation.builders.ApiInfoBuilder;


import springfox.documentation.builders.ParameterBuilder;


import springfox.documentation.builders.PathSelectors;


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 java.util.ArrayList;


import java.util.List;




/**


 * @author zhan_py


 * @Date 2024/1/26 16:11


 * Swagger2配置信息


 */


@Configuration


public class Swagger2Config {




    @Bean


    public Docket webApiConfig() {


        List<Parameter> pars = new ArrayList<>();


        ParameterBuilder tokenPar = new ParameterBuilder();


        tokenPar.name("userId")


                .description("用户token")


                //.defaultValue(JwtHelper.createToken(1L, "admin"))


                .defaultValue("1")


                .modelRef(new ModelRef("string"))


                .parameterType("header")


                .required(false)


                .build();


        pars.add(tokenPar.build());




        return new Docket(DocumentationType.SWAGGER_2)


                .groupName("webApi")


                .apiInfo(webApiInfo())


                .select()


                //只显示api路径下的页面


                .apis(RequestHandlerSelectors.basePackage("com.mes"))


                .paths(PathSelectors.any())


                .build()


                .globalOperationParameters(pars);


    }




    @Bean


    public Docket adminApiConfig() {


        List<Parameter> pars = new ArrayList<>();


        ParameterBuilder tokenPar = new ParameterBuilder();


        tokenPar.name("adminId")


                .description("用户token")


                .defaultValue("1")


                .modelRef(new ModelRef("string"))


                .parameterType("header")


                .required(false)


                .build();


        pars.add(tokenPar.build());




        return new Docket(DocumentationType.SWAGGER_2)


                .groupName("adminApi")


                .apiInfo(adminApiInfo())


                .select()


                //只显示admin路径下的页面


                .apis(RequestHandlerSelectors.basePackage("com.mes"))


                .paths(PathSelectors.any())


                .build()


                .globalOperationParameters(pars);


    }




    private ApiInfo webApiInfo() {


        return new ApiInfoBuilder()


                .title("网站-API文档")


                .description("本文档描述了mes网站微服务接口定义")


                .version("1.0")


                .contact(new Contact("zhan_py", "", ""))


                .build();


    }




    private ApiInfo adminApiInfo() {


        return new ApiInfoBuilder()


                .title("后台管理系统-API文档")


                .description("本文档描述了mes后台系统服务接口定义")


                .version("1.0")


                .contact(new Contact("zhan_py", "", ""))


                .build();


    }


}