dendi-wang/thingsboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added ability to change swagger group name (definition)

Browse Source
This commit is contained in:
YevhenBondarenko 2024-07-09 17:40:41 +02:00
parent 94b670d72e
commit bee9cfef9c
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
application/src/main/java/org/thingsboard/server/config/SwaggerConfiguration.java
View File

@ -113,7 +113,8 @@ public class SwaggerConfiguration {
private String version; private String version;
@Value("${app.version:unknown}") @Value("${app.version:unknown}")
private String appVersion; private String appVersion;
@Value("${swagger.group_name}")
private String groupName;
@Bean @Bean
public OpenAPI thingsboardApi() { public OpenAPI thingsboardApi() {
@ -212,7 +213,7 @@ public class SwaggerConfiguration {
@Bean @Bean
public GroupedOpenApi groupedApi(SpringDocParameterNameDiscoverer localSpringDocParameterNameDiscoverer) { public GroupedOpenApi groupedApi(SpringDocParameterNameDiscoverer localSpringDocParameterNameDiscoverer) {
return GroupedOpenApi.builder() return GroupedOpenApi.builder()
.group("thingsboard") .group(groupName)
.pathsToMatch(apiPath) .pathsToMatch(apiPath)
.addRouterOperationCustomizer(routerOperationCustomizer(localSpringDocParameterNameDiscoverer)) .addRouterOperationCustomizer(routerOperationCustomizer(localSpringDocParameterNameDiscoverer))
.addOperationCustomizer(operationCustomizer()) .addOperationCustomizer(operationCustomizer())

2
application/src/main/resources/thingsboard.yml
View File

@ -1385,6 +1385,8 @@ swagger:
url: "${SWAGGER_LICENSE_URL:https://github.com/thingsboard/thingsboard/blob/master/LICENSE}" 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. # The version of the API doc to display. Default to the package version.
version: "${SWAGGER_VERSION:}" version: "${SWAGGER_VERSION:}"
# The group name (definition) on the API doc UI page.
group_name: "${SWAGGER_GROUP_NAME:thingsboard}"
# Queue configuration parameters # Queue configuration parameters
queue: queue: