Skip to content

Commit 4119488

Browse files
author
18872241403
committed
[issues#2318]Add Info to GroupedOpenAPI properties
1 parent 2db978a commit 4119488

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configurer/SpringdocBeanFactoryConfigurer.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
package org.springdoc.core.configurer;
2626

2727
import java.util.List;
28+
import java.util.Optional;
2829

2930
import io.swagger.v3.oas.models.OpenAPI;
3031
import org.apache.commons.lang3.StringUtils;
@@ -98,6 +99,9 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
9899
builder.packagesToExclude(elt.getPackagesToExclude().toArray(new String[0]));
99100
if (StringUtils.isNotEmpty(elt.getDisplayName()))
100101
builder.displayName(elt.getDisplayName());
102+
if (Optional.ofNullable(elt.getApiInfo()).isPresent()) {
103+
builder.addOpenApiCustomizer(openApi -> openApi.info(elt.getApiInfo()));
104+
}
101105
return builder.group(elt.getGroup()).build();
102106
})
103107
.toList();

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SpringDocConfigProperties.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import java.util.Set;
3131

3232
import io.swagger.v3.oas.models.SpecVersion;
33+
import io.swagger.v3.oas.models.info.Info;
3334
import org.springdoc.core.configuration.SpringDocConfiguration;
3435
import org.springdoc.core.properties.SpringDocConfigProperties.ApiDocs.OpenApiVersion;
3536
import org.springdoc.core.utils.Constants;
@@ -1516,6 +1517,11 @@ public static class GroupConfig {
15161517
*/
15171518
private String displayName;
15181519

1520+
/**
1521+
* The object provides metadata about the API
1522+
*/
1523+
private Info apiInfo;
1524+
15191525
/**
15201526
* Instantiates a new Group config.
15211527
*/
@@ -1712,6 +1718,22 @@ public void setDisplayName(String displayName) {
17121718
this.displayName = displayName;
17131719
}
17141720

1721+
/**
1722+
* Gets api info
1723+
* @return the api info
1724+
*/
1725+
public Info getApiInfo() {
1726+
return apiInfo;
1727+
}
1728+
1729+
/**
1730+
* Sets api info
1731+
* @param apiInfo the api info
1732+
*/
1733+
public void setApiInfo(Info apiInfo) {
1734+
this.apiInfo = apiInfo;
1735+
}
1736+
17151737
@Override
17161738
public boolean equals(Object o) {
17171739
if (this == o) return true;

0 commit comments

Comments
 (0)