Mark GroupedOpenApi.setGroup as deprecated. Use GroupedOpenApi.group instead.

Author: bnasslahsen

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added separate module for spring-hateoas
 - Added SpringDocUtils.addHiddenRestControllers(String ...)
 - Added support for wrapper types on request
+- Mark GroupedOpenApi.setGroup as deprecated. Use GroupedOpenApi.group instead.
 ### Changed
 - Upgrade swagger-ui to 3.25.4
 - Upgrade to spring-boot 2.3.0.RELEASE

springdoc-openapi-common/src/main/java/org/springdoc/core/GroupedOpenApi.java

@@ -116,11 +116,17 @@ private Builder() {
 			// use static factory method in parent class
 		}
 
+		@Deprecated
 		public Builder setGroup(String group) {
 			this.group = group;
 			return this;
 		}
 
+		public Builder group(String group) {
+			this.group = group;
+			return this;
+		}
+
 		public Builder pathsToMatch(String... pathsToMatch) {
 			this.pathsToMatch = Arrays.asList(pathsToMatch);
 			return this;

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

@@ -63,7 +63,7 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
 							builder.packagesToScan(elt.getPackagesToScan().toArray(new String[0]));
 						if (!CollectionUtils.isEmpty(elt.getPathsToMatch()))
 							builder.pathsToMatch(elt.getPathsToMatch().toArray(new String[0]));
-						return builder.setGroup(elt.getGroup()).build();
+						return builder.group(elt.getGroup()).build();
 					})
 					.collect(Collectors.toList());
 			groupedOpenApis.forEach(elt -> beanFactory.registerSingleton(elt.getGroup(), elt));

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app4/SpringDocTestApp.java

@@ -35,7 +35,7 @@ public static void main(String[] args) {
 	public GroupedOpenApi storeOpenApi() {
 		String paths[] = { "/store/**" };
 		return GroupedOpenApi.builder()
-				.setGroup("stores")
+				.group("stores")
 				.pathsToMatch(paths)
 				.build();
 	}
@@ -44,7 +44,7 @@ public GroupedOpenApi storeOpenApi() {
 	public GroupedOpenApi groupOpenApi() {
 		String paths[] = { "/pet/**" };
 		return GroupedOpenApi.builder()
-				.setGroup("pets")
+				.group("pets")
 				.pathsToMatch(paths)
 				.build();
 	}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app6/SpringDocTestApp.java

@@ -35,7 +35,7 @@ public static void main(String[] args) {
 	public GroupedOpenApi storeOpenApi() {
 		String paths[] = { "/store/**" };
 		return GroupedOpenApi.builder()
-				.setGroup("stores")
+				.group("stores")
 				.pathsToMatch(paths)
 				.build();
 	}
@@ -44,7 +44,7 @@ public GroupedOpenApi storeOpenApi() {
 	public GroupedOpenApi groupOpenApi() {
 		String paths[] = { "/pet/**" };
 		return GroupedOpenApi.builder()
-				.setGroup("pets")
+				.group("pets")
 				.pathsToMatch(paths)
 				.build();
 	}

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app66/SpringDocTestApp.java

@@ -50,7 +50,7 @@ public OpenAPI customOpenAPI() {
 	public GroupedOpenApi streamOpenApi() {
 		String[] paths = { "/stream/**" };
 		String[] packagedToMatch = { "test.org.springdoc.api.app66" };
-		return GroupedOpenApi.builder().setGroup("stream").pathsToMatch(paths)
+		return GroupedOpenApi.builder().group("stream").pathsToMatch(paths)
 				.build();
 	}
 

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app68/SpringDocTestApp.java

@@ -48,15 +48,15 @@ public static void main(String[] args) {
 	@Bean
 	public GroupedOpenApi storeOpenApi() {
 		return GroupedOpenApi.builder()
-				.setGroup("stores")
+				.group("stores")
 				.pathsToMatch("/store/**")
 				.build();
 	}
 
 	@Bean
 	public GroupedOpenApi userOpenApi() {
 		return GroupedOpenApi.builder()
-				.setGroup("users")
+				.group("users")
 				.packagesToScan("test.org.springdoc.api.app68.api.user").addOpenApiCustomiser(serverOpenApiCustomiser1())
 				.addOperationCustomizer(operationCustomizer())
 				.build();
@@ -89,15 +89,15 @@ OperationCustomizer operationCustomizer() {
 	@Bean
 	public GroupedOpenApi petOpenApi() {
 		return GroupedOpenApi.builder()
-				.setGroup("pets")
+				.group("pets")
 				.pathsToMatch("/pet/**").addOpenApiCustomiser(serverOpenApiCustomiser2())
 				.build();
 	}
 
 	@Bean
 	public GroupedOpenApi groupOpenApi() {
 		return GroupedOpenApi.builder()
-				.setGroup("groups test")
+				.group("groups test")
 				.pathsToMatch("/v1/**").pathsToExclude("/v1/users")
 				.packagesToScan("test.org.springdoc.api.app68.api.user", "test.org.springdoc.api.app68.api.store")
 				.build();

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app72/BlockingAutoConfigurationTest.java

@@ -99,7 +99,7 @@ static class TestApp {
 		@Bean
 		GroupedOpenApi testGroupedOpenApi() {
 			return GroupedOpenApi.builder()
-					.setGroup("test-group")
+					.group("test-group")
 					.packagesToScan("org.test")
 					.build();
 		}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app72/GroupAutoConfigurationTest.java

@@ -48,7 +48,7 @@ static class TestApp {
 		@Bean
 		GroupedOpenApi testGroupedOpenApi() {
 			return GroupedOpenApi.builder()
-					.setGroup("test-group")
+					.group("test-group")
 					.packagesToScan("org.test")
 					.build();
 		}