lsm/initializr
1
0
Fork 0
mirror of https://gitee.com/dcren/initializr.git synced 2025-04-05 17:38:06 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Polish

Browse Source
This commit is contained in:
Stephane Nicoll 2019-02-11 11:22:45 +01:00
parent cbb60c45e1
commit 4658162d7c
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
initializr-docs/src/main/asciidoc/documentation-overview.adoc
View File

@ -10,11 +10,11 @@ audience so this reference guide is not meant to be read in a linear fashion.
Spring Initializr provides a simple web UI to configure the project to generate and
endpoints that you can use via plain HTTP: you can see our default instance at
https://start.spring.io. The service allows you to customize the project to generate: the
build system and its coordinates, the language and version, the packaging and finally the
dependencies to add to the project. The latter is a core concept: based on the chosen
Spring Boot version, a set of dependencies can be chosen, usually Spring Boot starters,
that will have a concrete impact on your application. More details in the
https://start.spring.io. The service allows you to customize the project to generate: the
build system and packaging, the language, the packaging, the coordinates, the platform
version and, finally, the dependencies to add to the project. Our default instance maps
the platform version to Spring Boot version and most dependencies to Spring Boot starters
which will have a concrete impact on your application. More details in the
<<user-guide.adoc#user-guide>> section.
You can easily create your own instance of the Initializr, by using the jars as libraries
@ -30,8 +30,8 @@ one. For those and other simple and common use cases check out
The Initializr also provides an extensible API to generate quickstart projects, and to
inspect the metadata used to generate projects, for instance to list the available
dependencies and versions. The API can be used standalone or embedded in other tools
(e.g. it is used in Spring Tool Suite, and in the IntelliJ IDEA and Netbeans plugins for
Spring Boot). These features are covered in <<api-guide.adoc#api-guide>>.
(e.g. it is used in major IDEs such as Spring Tool Suite, IntelliJ IDEA Ultimate, Netbeans
and VSCode). These features are covered in <<api-guide.adoc#api-guide>>.
[[initializr-documentation-about]]
== About the documentation

13
initializr-docs/src/main/asciidoc/user-guide.adoc
View File

@ -107,20 +107,20 @@ Boot version that is currently selected.
You may find it is not the case with a message that looks like the following:
```
requires Spring Boot >=1.0.0.RELEASE and <1.5.0.RC1
requires Spring Boot >=1.5.0.RELEASE and <2.0.0.RELEASE
```
Concretely, this defines a "version range" that states the dependency is deprecated and is
no longer available as of Spring Boot 1.5. You may want to check the release notes of the
no longer available as of Spring Boot 2.0. You may want to check the release notes of the
related project to understand what your migration path can be. Alternatively, the message
could be:
```
requires Spring Boot >=2.0.0.RELEASE
requires Spring Boot >=2.1.0.RELEASE
```
That version range means the dependency is not available with the current Spring Boot
generation. Obviously, if you select Spring Boot 2.0 (or later if available), you'll be
generation. Obviously, if you select Spring Boot 2.1 (or later if available), you'll be
able to select that dependency.
@ -189,12 +189,12 @@ understand how you can generate a project. These are obviously tailored to the c
you are using.
Let's assume that you want to generate a "my-project.zip" project based on Spring Boot
`1.5.2.RELEASE`, using the `web` and `devtools` dependencies (remember, those two ids are
`2.1.2.RELEASE`, using the `web` and `devtools` dependencies (remember, those two ids are
displayed in the capabilities of the service):
```
$ curl https://start.spring.io/starter.zip -d dependencies=web,devtools \
-d bootVersion=1.5.2.RELEASE -o my-project.zip
-d bootVersion=2.1.2.RELEASE -o my-project.zip
```
If you extract `my-project.zip`, you'll notice a few differences compared to what happens
@ -227,6 +227,7 @@ The following IDEs have dedicated support:
* Eclipse/STS
* IntelliJ IDEA (Ultimate Edition)
* NetBeans (using the http://plugins.netbeans.org/plugin/67888/nb-springboot[NB SpringBoot plugin])
* Microsoft VSCode
Refer to the documentation of your favorite IDE for more details.