code review

Author: bnasslahsen

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

@@ -117,7 +117,7 @@ public class OpenAPIService implements ApplicationContextAware {
 	/**
 	 * The server base URL customisers.
 	 */
-	private final Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomisers;
+	private final Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomizers;
 
 	/**
 	 * The Spring doc config properties.
@@ -202,7 +202,7 @@ public OpenAPIService(Optional<OpenAPI> openAPI, SecurityService securityParser,
 		this.securityParser = securityParser;
 		this.springDocConfigProperties = springDocConfigProperties;
 		this.openApiBuilderCustomisers = openApiBuilderCustomisers;
-		this.serverBaseUrlCustomisers = serverBaseUrlCustomisers;
+		this.serverBaseUrlCustomizers = serverBaseUrlCustomisers;
 		if (springDocConfigProperties.isUseFqn())
 			TypeNameResolver.std.setUseFqn(true);
 	}
@@ -443,9 +443,9 @@ public void buildTagsFromClass(Class<?> beanType, Set<io.swagger.v3.oas.models.t
 	public void setServerBaseUrl(String serverBaseUrl) {
 		String customServerBaseUrl = serverBaseUrl;
 
-		if (serverBaseUrlCustomisers != null && serverBaseUrlCustomisers.isPresent()) {
-			for (ServerBaseUrlCustomizer customiser : serverBaseUrlCustomisers.get()) {
-				customServerBaseUrl = customiser.customise(customServerBaseUrl);
+		if (serverBaseUrlCustomizers != null && serverBaseUrlCustomizers.isPresent()) {
+			for (ServerBaseUrlCustomizer customiser : serverBaseUrlCustomizers.get()) {
+				customServerBaseUrl = customiser.customize(customServerBaseUrl);
 			}
 		}
 

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/ServerBaseUrlCustomizer.java

@@ -13,5 +13,5 @@ public interface ServerBaseUrlCustomizer {
 	 * @param serverBaseUrl the serverBaseUrl.
 	 * @return the customised serverBaseUrl
 	 */
-	public String customise(String serverBaseUrl);
+	String customize(String serverBaseUrl);
 }

springdoc-openapi-common/src/test/java/org/springdoc/api/AbstractOpenApiResourceTest.java

@@ -113,7 +113,7 @@ public void setUp() {
 		openAPI = new OpenAPI();
 		openAPI.setPaths(new Paths().addPathItem(PATH, new PathItem()));
 		ReflectionTestUtils.setField(openAPIService, "cachedOpenAPI", new HashMap<>());
-		ReflectionTestUtils.setField(openAPIService, "serverBaseUrlCustomisers", Optional.empty());
+		ReflectionTestUtils.setField(openAPIService, "serverBaseUrlCustomizers", Optional.empty());
 
 		when(openAPIService.getCalculatedOpenAPI()).thenReturn(openAPI);
 		when(openAPIService.getContext()).thenReturn(context);
@@ -246,19 +246,19 @@ void serverBaseUrlCustomisersTest() throws InterruptedException {
 
 		Locale locale = Locale.US;
 
-		// Test that setting generated URL works fine with no customisers present
+		// Test that setting generated URL works fine with no customizers present
 		String generatedUrl = "https://generated-url.com/context-path";
 		openAPIService.setServerBaseUrl(generatedUrl);
 		openAPIService.updateServers(openAPI);
 		OpenAPI after = resource.getOpenApi(locale);
 		assertThat(after.getServers().get(0).getUrl(), is(generatedUrl));
 
-		// Test that adding a serverBaseUrlCustomiser has the desired effect
-		ServerBaseUrlCustomizer serverBaseUrlCustomiser = serverBaseUrl -> serverBaseUrl.replace("/context-path", "");
-		List<ServerBaseUrlCustomizer> serverBaseUrlCustomiserList = new ArrayList<>();
-		serverBaseUrlCustomiserList.add(serverBaseUrlCustomiser);
+		// Test that adding a serverBaseUrlCustomizer has the desired effect
+		ServerBaseUrlCustomizer serverBaseUrlCustomizer = serverBaseUrl -> serverBaseUrl.replace("/context-path", "");
+		List<ServerBaseUrlCustomizer> serverBaseUrlCustomizerList = new ArrayList<>();
+		serverBaseUrlCustomizerList.add(serverBaseUrlCustomizer);
 
-		ReflectionTestUtils.setField(openAPIService, "serverBaseUrlCustomisers", Optional.of(serverBaseUrlCustomiserList));
+		ReflectionTestUtils.setField(openAPIService, "serverBaseUrlCustomizers", Optional.of(serverBaseUrlCustomizerList));
 		openAPIService.setServerBaseUrl(generatedUrl);
 		openAPIService.updateServers(openAPI);
 		after = resource.getOpenApi(locale);
@@ -267,7 +267,7 @@ void serverBaseUrlCustomisersTest() throws InterruptedException {
 		// Test that serverBaseUrlCustomisers are performed in order
 		generatedUrl = "https://generated-url.com/context-path/second-path";
 		ServerBaseUrlCustomizer serverBaseUrlCustomiser2 = serverBaseUrl -> serverBaseUrl.replace("/context-path/second-path", "");
-		serverBaseUrlCustomiserList.add(serverBaseUrlCustomiser2);
+		serverBaseUrlCustomizerList.add(serverBaseUrlCustomiser2);
 
 		openAPIService.setServerBaseUrl(generatedUrl);
 		openAPIService.updateServers(openAPI);
@@ -276,7 +276,7 @@ void serverBaseUrlCustomisersTest() throws InterruptedException {
 
 		// Test that all serverBaseUrlCustomisers in the List are performed
 		ServerBaseUrlCustomizer serverBaseUrlCustomiser3 = serverBaseUrl -> serverBaseUrl.replace("/second-path", "");
-		serverBaseUrlCustomiserList.add(serverBaseUrlCustomiser3);
+		serverBaseUrlCustomizerList.add(serverBaseUrlCustomiser3);
 
 		openAPIService.setServerBaseUrl(generatedUrl);
 		openAPIService.updateServers(openAPI);