增加: Swagger开关配置项

This commit is contained in:
TinyAnts 2023-03-15 15:23:51 +08:00
parent c84b597032
commit 58999e6fbc
6 changed files with 52 additions and 4 deletions

View File

@ -1,6 +1,7 @@
package com.mdd.admin.config; package com.mdd.admin.config;
import com.mdd.common.config.GlobalConfig; import com.mdd.common.config.GlobalConfig;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ApiInfoBuilder;
@ -14,14 +15,21 @@ import springfox.documentation.spring.web.plugins.Docket;
@EnableOpenApi @EnableOpenApi
public class SwaggerConfig { public class SwaggerConfig {
@Value("${like.swagger.enabled}")
private boolean enabled;
@Value("${like.swagger.pathMapping}")
private String pathMapping;
@Bean @Bean
public Docket createRestApi(){ public Docket createRestApi(){
return new Docket(DocumentationType.OAS_30) return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo()) .apiInfo(apiInfo())
.enable(true) .enable(enabled)
.select() .select()
.apis(RequestHandlerSelectors.basePackage("com.mdd.admin.controller")) .apis(RequestHandlerSelectors.basePackage("com.mdd.admin.controller"))
.build(); .build()
.pathMapping(pathMapping);
} }
private ApiInfo apiInfo(){ private ApiInfo apiInfo(){

View File

@ -24,6 +24,16 @@
"name": "like.captcha.token", "name": "like.captcha.token",
"type": "java.lang.String", "type": "java.lang.String",
"description": "Description for like.captcha.token." "description": "Description for like.captcha.token."
},
{
"name": "like.swagger.enabled",
"type": "java.lang.String",
"description": "Description for like.swagger.enabled."
},
{
"name": "like.swagger.pathMapping",
"type": "java.lang.String",
"description": "Description for like.swagger.pathMapping."
} }
] ]
} }

View File

@ -9,6 +9,12 @@ like:
expire: 120 expire: 120
# 验证码缓存键名 # 验证码缓存键名
token: "captcha:key:" token: "captcha:key:"
# Swagger配置
swagger:
# 是否开启swagger
enabled: true
# 请求前缀
pathMapping: /dev-api
# 服务配置 # 服务配置
server: server:

View File

@ -1,6 +1,7 @@
package com.mdd.front.config; package com.mdd.front.config;
import com.mdd.common.config.GlobalConfig; import com.mdd.common.config.GlobalConfig;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ApiInfoBuilder;
@ -14,14 +15,21 @@ import springfox.documentation.spring.web.plugins.Docket;
@EnableOpenApi @EnableOpenApi
public class SwaggerConfig { public class SwaggerConfig {
@Value("${like.swagger.enabled}")
private boolean enabled;
@Value("${like.swagger.pathMapping}")
private String pathMapping;
@Bean @Bean
public Docket createRestApi(){ public Docket createRestApi(){
return new Docket(DocumentationType.OAS_30) return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo()) .apiInfo(apiInfo())
.enable(true) .enable(enabled)
.select() .select()
.apis(RequestHandlerSelectors.basePackage("com.mdd.front")) .apis(RequestHandlerSelectors.basePackage("com.mdd.front"))
.build(); .build()
.pathMapping(pathMapping);
} }
private ApiInfo apiInfo(){ private ApiInfo apiInfo(){

View File

@ -4,6 +4,16 @@
"name": "like.upload-directory", "name": "like.upload-directory",
"type": "java.lang.String", "type": "java.lang.String",
"description": "Description for like.upload-directory." "description": "Description for like.upload-directory."
},
{
"name": "like.swagger.enabled",
"type": "java.lang.String",
"description": "Description for like.swagger.enabled."
},
{
"name": "like.swagger.pathMapping",
"type": "java.lang.String",
"description": "Description for like.swagger.pathMapping."
} }
] ]
} }

View File

@ -2,6 +2,12 @@
like: like:
# 上传目录 # 上传目录
upload-directory: /www/uploads/likeadmin-java/ upload-directory: /www/uploads/likeadmin-java/
# Swagger配置
swagger:
# 是否开启swagger
enabled: true
# 请求前缀
pathMapping: /dev-api
# 服务配置 # 服务配置
server: server: