
Swagger2的接口配置
description("描述:用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...")// 扫描所有 .apis(RequestHandlerSelectors.any())// 用来创建该API的基本信息,展示在文档的页面中(自定义展示的信息).title("标题:若依管理系统_接口文档")// 扫描所有有注解的api,用这种方式更灵活。// 设置哪些接口暴露给Swagger展示。
·
搭配依赖
<swagger.version>2.9.2</swagger.version
/**
* Swagger2的接口配置
*
* @author guquanyou
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig
{
/**
* 创建API
*/
@Bean
public Docket createRestApi()
{
return new Docket(DocumentationType.SWAGGER_2)
// 用来创建该API的基本信息,展示在文档的页面中(自定义展示的信息)
.apiInfo(apiInfo())
// 设置哪些接口暴露给Swagger展示
.select()
// 扫描所有有注解的api,用这种方式更灵活
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
// 扫描指定包中的swagger注解
//.apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
// 扫描所有 .apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
/**
* 添加摘要信息
*/
private ApiInfo apiInfo()
{
// 用ApiInfoBuilder进行定制
return new ApiInfoBuilder()
// 设置标题
.title("标题:若依管理系统_接口文档")
// 描述
.description("描述:用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...")
// 作者信息
.contact(new Contact(Global.getName(), null, null))
// 版本
.version("版本号:" + Global.getVersion())
.build();
}
}
更多推荐
所有评论(0)