package com.ruoyi.web.core.config;
|
|
import org.springframework.beans.factory.annotation.Value;
|
import org.springframework.context.annotation.Bean;
|
import org.springframework.context.annotation.Configuration;
|
import com.ruoyi.common.config.RuoYiConfig;
|
import io.swagger.annotations.ApiOperation;
|
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;
|
|
/**
|
* Swagger2的接口配置
|
*
|
* @author ruoyi
|
*/
|
@Configuration
|
public class SwaggerConfig
|
{
|
/** 是否开启swagger */
|
@Value("${swagger.enabled}")
|
private boolean enabled;
|
|
/**
|
* 创建API
|
*/
|
@Bean
|
public Docket createRestApi()
|
{
|
return new Docket(DocumentationType.OAS_30)
|
// 是否启用Swagger
|
.enable(enabled)
|
// 用来创建该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(RuoYiConfig.getName(), null, null))
|
// 版本
|
.version("版本号:" + RuoYiConfig.getVersion())
|
.build();
|
}
|
}
|
