Add support for configuration file format to the initializr-web module

YangSiJun528 · YangSiJun528 · commit d819723ab45c · 2025-07-30T17:20:14.000+09:00
diff --git a/initializr-web/src/main/java/io/spring/initializr/web/mapper/InitializrMetadataV2JsonMapper.java b/initializr-web/src/main/java/io/spring/initializr/web/mapper/InitializrMetadataV2JsonMapper.java
@@ -88,6 +88,7 @@ public String write(InitializrMetadata metadata, String appUrl) {
 		singleSelect(parent, metadata.getPackagings());
 		singleSelect(parent, metadata.getJavaVersions());
 		singleSelect(parent, metadata.getLanguages());
+		singleSelect(parent, metadata.getConfigurationFileFormats());
 		singleSelect(parent, metadata.getBootVersions(), this::mapVersionMetadata, this::formatVersion);
 		text(parent, metadata.getGroupId());
 		text(parent, metadata.getArtifactId());
diff --git a/initializr-web/src/main/java/io/spring/initializr/web/project/DefaultProjectRequestToDescriptionConverter.java b/initializr-web/src/main/java/io/spring/initializr/web/project/DefaultProjectRequestToDescriptionConverter.java
@@ -22,6 +22,7 @@
 import java.util.stream.Collectors;
 
 import io.spring.initializr.generator.buildsystem.BuildSystem;
+import io.spring.initializr.generator.configuration.format.ConfigurationFileFormat;
 import io.spring.initializr.generator.language.Language;
 import io.spring.initializr.generator.packaging.Packaging;
 import io.spring.initializr.generator.project.MutableProjectDescription;
@@ -91,6 +92,7 @@ public void convert(ProjectRequest request, MutableProjectDescription descriptio
 		description.setDescription(request.getDescription());
 		description.setGroupId(cleanInputValue(request.getGroupId()));
 		description.setLanguage(Language.forId(request.getLanguage(), request.getJavaVersion()));
+		description.setConfigurationFileFormat(ConfigurationFileFormat.forId(request.getConfigurationFileFormat()));
 		description.setName(cleanInputValue(request.getName()));
 		description.setPackageName(cleanInputValue(request.getPackageName()));
 		description.setPackaging(Packaging.forId(request.getPackaging()));
@@ -114,6 +116,7 @@ private void validate(ProjectRequest request, InitializrMetadata metadata) {
 		validatePlatformVersion(request, metadata);
 		validateType(request.getType(), metadata);
 		validateLanguage(request.getLanguage(), metadata);
+		validateConfigurationFileFormat(request.getConfigurationFileFormat(), metadata);
 		validatePackaging(request.getPackaging(), metadata);
 		validateDependencies(request, metadata);
 	}
@@ -149,6 +152,17 @@ private void validateLanguage(String language, InitializrMetadata metadata) {
 		}
 	}
 
+	private void validateConfigurationFileFormat(String configurationFileFormat, InitializrMetadata metadata) {
+		if (configurationFileFormat != null) {
+			DefaultMetadataElement configurationFileFormatFromMetadata = metadata.getConfigurationFileFormats()
+				.get(configurationFileFormat);
+			if (configurationFileFormatFromMetadata == null) {
+				throw new InvalidProjectRequestException(
+						"Unknown configuration file format '" + configurationFileFormat + "' check project metadata");
+			}
+		}
+	}
+
 	private void validatePackaging(String packaging, InitializrMetadata metadata) {
 		if (packaging != null) {
 			DefaultMetadataElement packagingFromMetadata = metadata.getPackagings().get(packaging);
diff --git a/initializr-web/src/main/java/io/spring/initializr/web/project/ProjectRequest.java b/initializr-web/src/main/java/io/spring/initializr/web/project/ProjectRequest.java
@@ -50,6 +50,8 @@ public class ProjectRequest {
 
 	private String language;
 
+	private String configurationFileFormat;
+
 	private String packageName;
 
 	private String javaVersion;
@@ -145,6 +147,14 @@ public void setLanguage(String language) {
 		this.language = language;
 	}
 
+	public String getConfigurationFileFormat() {
+		return this.configurationFileFormat;
+	}
+
+	public void setConfigurationFileFormat(String configurationFileFormat) {
+		this.configurationFileFormat = configurationFileFormat;
+	}
+
 	public String getPackageName() {
 		if (StringUtils.hasText(this.packageName)) {
 			return this.packageName;
diff --git a/initializr-web/src/test/java/io/spring/initializr/web/AbstractInitializrIntegrationTests.java b/initializr-web/src/test/java/io/spring/initializr/web/AbstractInitializrIntegrationTests.java
@@ -167,8 +167,7 @@ protected void assertDefaultProject(ProjectStructure project) {
 
 	protected void assertDefaultJavaProject(ProjectStructure project) {
 		assertThat(project).containsFiles("src/main/java/com/example/demo/DemoApplication.java",
-				"src/test/java/com/example/demo/DemoApplicationTests.java",
-				"src/main/resources/application.properties");
+				"src/test/java/com/example/demo/DemoApplicationTests.java");
 	}
 
 	protected void assertHasWebResources(ProjectStructure project) {
diff --git a/initializr-web/src/test/java/io/spring/initializr/web/controller/ProjectGenerationControllerIntegrationTests.java b/initializr-web/src/test/java/io/spring/initializr/web/controller/ProjectGenerationControllerIntegrationTests.java
@@ -53,7 +53,37 @@ void simpleZipProject() {
 			// alias: jpa -> data-jpa
 			.hasDependency(Dependency.createSpringBootStarter("data-jpa"))
 			.hasDependency(Dependency.createSpringBootStarter("test", Dependency.SCOPE_TEST));
+		// default configuration file format is .properties
+		assertThat(project).containsFiles("src/main/resources/application.properties");
+	}
+
+	@Test
+	void simpleZipProjectWithPropertiesFormat() {
+		ResponseEntity<byte[]> entity = downloadArchive(
+				"/starter.zip?dependencies=web&configurationFileFormat=properties");
+		assertArchiveResponseHeaders(entity, MediaType.valueOf("application/zip"), "demo.zip");
+		ProjectStructure project = projectFromArchive(entity.getBody());
+		assertDefaultProject(project);
+		assertHasWebResources(project);
+		assertThat(project).mavenBuild()
+			.hasDependenciesSize(2)
+			.hasDependency(Dependency.createSpringBootStarter("web"))
+			.hasDependency(Dependency.createSpringBootStarter("test", Dependency.SCOPE_TEST));
+		assertThat(project).containsFiles("src/main/resources/application.properties");
+	}
 
+	@Test
+	void simpleZipProjectWithYAMLFormat() {
+		ResponseEntity<byte[]> entity = downloadArchive("/starter.zip?dependencies=web&&configurationFileFormat=yml");
+		assertArchiveResponseHeaders(entity, MediaType.valueOf("application/zip"), "demo.zip");
+		ProjectStructure project = projectFromArchive(entity.getBody());
+		assertDefaultProject(project);
+		assertHasWebResources(project);
+		assertThat(project).mavenBuild()
+			.hasDependenciesSize(2)
+			.hasDependency(Dependency.createSpringBootStarter("web"))
+			.hasDependency(Dependency.createSpringBootStarter("test", Dependency.SCOPE_TEST));
+		assertThat(project).containsFiles("src/main/resources/application.yml");
 	}
 
 	@Test
diff --git a/initializr-web/src/test/resources/application-test-default.yml b/initializr-web/src/test/resources/application-test-default.yml
@@ -150,6 +150,13 @@ initializr:
     - name: Kotlin
       id: kotlin
       default: false
+  configuration-file-formats:
+    - name: Properties
+      id: properties
+      default: true
+    - name: YAML
+      id: yml
+      default: false
   bootVersions:
     - name : Latest SNAPSHOT
       id: 2.5.0-SNAPSHOT
diff --git a/initializr-web/src/test/resources/metadata/config/test-default.json b/initializr-web/src/test/resources/metadata/config/test-default.json
@@ -320,6 +320,24 @@
     "title": "Language",
     "type": "SINGLE_SELECT"
   },
+  "configurationFileFormats": {
+    "content": [
+      {
+        "default": true,
+        "id": "properties",
+        "name": "Properties"
+      },
+      {
+        "default": false,
+        "id": "yml",
+        "name": "YAML"
+      }
+    ],
+    "description": "configuration file format",
+    "id": "configurationFileFormat",
+    "title": "Configuration File Format",
+    "type": "SINGLE_SELECT"
+  },
   "name": {
     "content": "demo",
     "description": "project name (infer application name)",
diff --git a/initializr-web/src/test/resources/metadata/test-default-2.0.0-ssl.json b/initializr-web/src/test/resources/metadata/test-default-2.0.0-ssl.json
@@ -149,6 +149,20 @@
       }
     ]
   },
+  "configurationFileFormat": {
+    "type": "single-select",
+    "default": "properties",
+    "values": [
+      {
+        "id": "properties",
+        "name": "Properties"
+      },
+      {
+        "id": "yml",
+        "name": "YAML"
+      }
+    ]
+  },
   "bootVersion": {
     "type": "single-select",
     "default": "2.4.4.RELEASE",
diff --git a/initializr-web/src/test/resources/metadata/test-default-2.0.0.json b/initializr-web/src/test/resources/metadata/test-default-2.0.0.json
@@ -149,6 +149,20 @@
       }
     ]
   },
+  "configurationFileFormat": {
+    "type": "single-select",
+    "default": "properties",
+    "values": [
+      {
+        "id": "properties",
+        "name": "Properties"
+      },
+      {
+        "id": "yml",
+        "name": "YAML"
+      }
+    ]
+  },
   "bootVersion": {
     "type": "single-select",
     "default": "2.4.4.RELEASE",
diff --git a/initializr-web/src/test/resources/metadata/test-default-2.1.0-ssl.json b/initializr-web/src/test/resources/metadata/test-default-2.1.0-ssl.json
@@ -187,6 +187,20 @@
       }
     ]
   },
+  "configurationFileFormat": {
+    "type": "single-select",
+    "default": "properties",
+    "values": [
+      {
+        "id": "properties",
+        "name": "Properties"
+      },
+      {
+        "id": "yml",
+        "name": "YAML"
+      }
+    ]
+  },
   "bootVersion": {
     "type": "single-select",
     "default": "2.4.4.RELEASE",
diff --git a/initializr-web/src/test/resources/metadata/test-default-2.1.0.json b/initializr-web/src/test/resources/metadata/test-default-2.1.0.json
@@ -187,6 +187,20 @@
       }
     ]
   },
+  "configurationFileFormat": {
+    "type": "single-select",
+    "default": "properties",
+    "values": [
+      {
+        "id": "properties",
+        "name": "Properties"
+      },
+      {
+        "id": "yml",
+        "name": "YAML"
+      }
+    ]
+  },
   "bootVersion": {
     "type": "single-select",
     "default": "2.4.4.RELEASE",
diff --git a/initializr-web/src/test/resources/metadata/test-default-2.2.0.json b/initializr-web/src/test/resources/metadata/test-default-2.2.0.json
@@ -187,6 +187,20 @@
       }
     ]
   },
+  "configurationFileFormat": {
+    "type": "single-select",
+    "default": "properties",
+    "values": [
+      {
+        "id": "properties",
+        "name": "Properties"
+      },
+      {
+        "id": "yml",
+        "name": "YAML"
+      }
+    ]
+  },
   "bootVersion": {
     "type": "single-select",
     "default": "2.4.4",

Original file line number	Diff line number	Diff line change
`@@ -167,8 +167,7 @@ protected void assertDefaultProject(ProjectStructure project) {`
`167`	`167`
`168`	`168`	`protected void assertDefaultJavaProject(ProjectStructure project) {`
`169`	`169`	`assertThat(project).containsFiles("src/main/java/com/example/demo/DemoApplication.java",`
`170`		`- "src/test/java/com/example/demo/DemoApplicationTests.java",`
`171`		`- "src/main/resources/application.properties");`
	`170`	`+ "src/test/java/com/example/demo/DemoApplicationTests.java");`
`172`	`171`	`}`
`173`	`172`
`174`	`173`	`protected void assertHasWebResources(ProjectStructure project) {`