SwaggerConfig.java 2.8 KB
package com.sunyo.wlpt.dispatch.config;

import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.VendorExtension;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

/**
 * @author 子诚
 * Description:
 * 时间:2020/4/21 11:32
 */

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket(Environment environment) {
        //设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev", "test");
        //通过environment.acceptsProfiles,判定是否处在自己设置的环境中
        boolean flag = environment.acceptsProfiles(profiles);
        //版本类型是swagger2
        return new Docket(DocumentationType.SWAGGER_2)
                //通过调用自定义方法apiInfo,获得文档的主要信息
                .apiInfo(apiInfo())
                //分组
                .groupName("子诚")
                //如果是自己设置的环境,就是true,即打开swagger
                .enable(true)

                .select()
                //RequestHandlerSelectors,配置要扫描接口的方式
                //basePackage:配置要扫描的包,扫描该包下面的API注解
                .apis(RequestHandlerSelectors.basePackage("com.sunyo.wlpt.dispatch.controller"))
                //PathSelectors.any(),扫描全部;none(),全部都不扫描;withMethodAnnotation:扫描方法上的注解

                //paths:过滤什么路径
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 配置swagger信息==apiInfo
     *
     * @return
     */
    private ApiInfo apiInfo() {
        //作者信息
        Contact contact = new Contact("子诚", "http://127.0.0.1:9999", "523186180@qq.com");
        return new ApiInfo(
                "车辆调度系统",
                "春花秋月,夏日冬雪",
                "1.0",
                "http://127.0.0.1:9999",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<VendorExtension>());
    }
}