lsm/initializr
1
0
Fork 0
mirror of https://gitee.com/dcren/initializr.git synced 2025-07-17 01:46:19 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve configuration guide

Browse Source
This commit is contained in:
Stephane Nicoll 2019-02-11 12:31:27 +01:00
parent 0ed3bdddaa
commit de15e826b8
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
initializr-docs/src/main/asciidoc/configuration-guide.adoc
View File

@ -81,10 +81,14 @@ conditions can easily be created by inheriting from `ProjectGenerationCondition`
[[create-instance]] [[create-instance]]
== Creating your own instance == Creating your own instance
Spring Initializr is split across three main modules: Spring Initializr is split across several modules:
* `initializr-generator`: standalone project generation library that can be reused in * `initializr-generator`: standalone project generation library that can be reused in
many environments (including embedded in your own project) many environments (including embedded in your own project)
* `initializr-generator-spring`: contributors to generate a Spring-based project. This
module is necessary if you want to generate the same project structure as the one
available on start.spring.io. Alternatively, you can roll-out your own opinions.
* `initializr-metadata`: Configuration model.
* `initializr-web`: API endpoints and web interface * `initializr-web`: API endpoints and web interface
* `initializr-actuator`: optional module to provide additional information and statistics * `initializr-actuator`: optional module to provide additional information and statistics
on project generation on project generation
@ -134,13 +138,13 @@ Most of the drop-down lists are configured via a simple list-based structure whe
entry has an `id`, a `name` and whether that entry is the default or not. If no `name` is entry has an `id`, a `name` and whether that entry is the default or not. If no `name` is
provided, the `id` is used instead. provided, the `id` is used instead.
Let's configure the languages and the Java versions we want to support: Let's configure the languages and the JVM generations we want to support:
[source,yaml,indent=0] [source,yaml,indent=0]
---- ----
initializr: initializr:
javaVersions: javaVersions:
- id: 9 - id: 11
default: false default: false
- id: 1.8 - id: 1.8
default: true default: true
@ -156,8 +160,8 @@ Let's configure the languages and the Java versions we want to support:
If you click on the "Switch to the full version" link, the two drop down lists now offer If you click on the "Switch to the full version" link, the two drop down lists now offer
the options and default values defined above. the options and default values defined above.
Spring Initializr supports `java`, `groovy` and `kotlin` and additional languages can be NOTE: The language identifiers defined there must have a corresponding `Language`
added in your own customization. implementation. `java`, `kotlin` and `groovy` can be used out-of-the-box.
The available packagings are also configurable that way: The available packagings are also configurable that way:
@ -173,8 +177,7 @@ The available packagings are also configurable that way:
default: false default: false
---- ----
These two packaging types are the only one explicitly supported at the moment. NOTE: Additional packages can be configured by implementing the `Packaging` abstraction.
[[create-instance-boot-versions]] [[create-instance-boot-versions]]
@ -227,7 +230,7 @@ By default, Spring Initializr exposes the following resources (all accessed via
Each type also defines one or more *tags* that provides additional metadata entries to Each type also defines one or more *tags* that provides additional metadata entries to
qualify the entry. The following standard tags exist: qualify the entry. The following standard tags exist:
* `build`: the name of the build system to use (e.g. `maven`, `gradle`) * `build`: the name of the `BuildSystem` to use (e.g. `maven`, `gradle`)
* `format`: the format of the project (e.g. `project` for a full project, `build` for just * `format`: the format of the project (e.g. `project` for a full project, `build` for just
a build file). a build file).