package com.dai.party.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
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.builders.RequestHandlerSelectors;
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;

/**
 * @program: partyAffairs
 * @description:项目后台Swagger2配置
 * @author: Dai Yuanchuan
 * @create: 2019-01-11 00:19
 **/
@Configuration
@ConditionalOnProperty(prefix = "swagger",value = {"enable"},havingValue = "true")
@EnableSwagger2
public class BackstageSwagger2Configuration {

    /**
     * SWAGR2的配置文件，其中可以配置SWAGR2的一些基本元素，如扫描包等。
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //这里是包路径
                .apis(RequestHandlerSelectors.basePackage("com.dai.party.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 建立API文档的详细信息功能，注意这里引用的是哪一个。
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("系统后台 接口说明文档")
                .description("API 描述")
                .termsOfServiceUrl("javascript:void(0);")
                .contact(new Contact("Dai Yuanchuan", "", "novel-web@novelweb.cn"))
                .version("1.0")
                .build();
    }

}