From 14bb7fd2f785c66a0daba3085637ab731770b0ec Mon Sep 17 00:00:00 2001 From: YevhenBondarenko Date: Fri, 5 Jul 2024 14:56:49 +0200 Subject: [PATCH 1/3] fixed enable/disable swagger --- .../org/thingsboard/server/config/SwaggerConfiguration.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java b/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java index 963205c08b..1ae6da9f4b 100644 --- a/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java +++ b/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java @@ -48,6 +48,7 @@ import org.springdoc.core.models.GroupedOpenApi; import org.springdoc.core.properties.SpringDocConfigProperties; import org.springdoc.core.properties.SwaggerUiConfigProperties; import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Lazy; @@ -62,7 +63,6 @@ import org.thingsboard.server.common.data.exception.ThingsboardErrorCode; import org.thingsboard.server.common.data.security.Authority; import org.thingsboard.server.exception.ThingsboardCredentialsExpiredResponse; import org.thingsboard.server.exception.ThingsboardErrorResponse; -import org.thingsboard.server.queue.util.TbCoreComponent; import org.thingsboard.server.service.security.auth.rest.LoginRequest; import org.thingsboard.server.service.security.auth.rest.LoginResponse; @@ -79,7 +79,7 @@ import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE; @Slf4j @Configuration -@TbCoreComponent +@ConditionalOnExpression("('${service.type:null}'=='monolith' || '${service.type:null}'=='tb-core') && '${springdoc.api-docs.enabled:true}'=='true'") @Profile("!test") public class SwaggerConfiguration { From bee9cfef9cace946924139d20b4177da42ebd8ff Mon Sep 17 00:00:00 2001 From: YevhenBondarenko Date: Tue, 9 Jul 2024 17:40:41 +0200 Subject: [PATCH 2/3] added ability to change swagger group name (definition) --- .../org/thingsboard/server/config/SwaggerConfiguration.java | 5 +++-- application/src/main/resources/thingsboard.yml | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java b/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java index 963205c08b..930db24a25 100644 --- a/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java +++ b/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java @@ -113,7 +113,8 @@ public class SwaggerConfiguration { private String version; @Value("${app.version:unknown}") private String appVersion; - + @Value("${swagger.group_name}") + private String groupName; @Bean public OpenAPI thingsboardApi() { @@ -212,7 +213,7 @@ public class SwaggerConfiguration { @Bean public GroupedOpenApi groupedApi(SpringDocParameterNameDiscoverer localSpringDocParameterNameDiscoverer) { return GroupedOpenApi.builder() - .group("thingsboard") + .group(groupName) .pathsToMatch(apiPath) .addRouterOperationCustomizer(routerOperationCustomizer(localSpringDocParameterNameDiscoverer)) .addOperationCustomizer(operationCustomizer()) diff --git a/application/src/main/resources/thingsboard.yml b/application/src/main/resources/thingsboard.yml index 4e5458bd18..03a0a4f849 100644 --- a/application/src/main/resources/thingsboard.yml +++ b/application/src/main/resources/thingsboard.yml @@ -1385,6 +1385,8 @@ swagger: url: "${SWAGGER_LICENSE_URL:https://github.com/thingsboard/thingsboard/blob/master/LICENSE}" # The version of the API doc to display. Default to the package version. version: "${SWAGGER_VERSION:}" + # The group name (definition) on the API doc UI page. + group_name: "${SWAGGER_GROUP_NAME:thingsboard}" # Queue configuration parameters queue: From 138f95e1c0c2d8461e4466609d6f4d57f72a6dbd Mon Sep 17 00:00:00 2001 From: Viacheslav Klimov Date: Wed, 10 Jul 2024 10:34:06 +0300 Subject: [PATCH 3/3] Default prop value for Swagger group name --- .../org/thingsboard/server/config/SwaggerConfiguration.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java b/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java index 930db24a25..1c6309627c 100644 --- a/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java +++ b/application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java @@ -113,7 +113,7 @@ public class SwaggerConfiguration { private String version; @Value("${app.version:unknown}") private String appVersion; - @Value("${swagger.group_name}") + @Value("${swagger.group_name:thingsboard}") private String groupName; @Bean