0
点赞
收藏
分享

微信扫一扫

swagger开关,swagger接口文档开关

package com.peony.electric.server.config;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import com.peony.common.entity.po.TaskPO;
import com.peony.common.enums.TaskStatus;
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 springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
* @author 杜云山
* @date 2019/10/26
*/
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class Swagger2Config {

@Bean
public Docket createRestApi() {
boolean show=false;//开关配置,可以配置到配置文件
//只有本地启动才有接口文档
String os = System.getProperties().getProperty("os.name");
if(os.contains("Windows")){show=true;}
return new Docket(DocumentationType.SWAGGER_2).enable(show)
.directModelSubstitute(TaskPO.class, String.class)
.directModelSubstitute(TaskStatus.class, String.class)
.apiInfo(apiInfo())
.host("localhost")
.globalOperationParameters(parameters())
.select()
//Swagger UI默认显示所有接口
.apis(RequestHandlerSelectors.basePackage("com.peony.electric.server"))
.paths(PathSelectors.any())
.build();
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 设置页面标题
.title("api接口文档")
// 设置联系人
.contact(new Contact("暂无name", "暂无url", "暂无email"))
// 描述
.description("欢迎访问接口文档,这里是描述信息")
// 定义版本号
.version("1.0")
.build();
}

/**
* 全局参数
*
* @return List<Parameter>
*/
private List<Parameter> parameters() {
List<Parameter> params = new ArrayList<>();
params.add(new ParameterBuilder()
.name("token")
.description("认证令牌,登录外其他接口必填")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(false)
.build());
params.add(new ParameterBuilder()
.name("imei")
.description("APP端需传入设备的imei")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(false)
.build());
return params;
}
}

 


举报

相关推荐

0 条评论