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

Use Spring Initializr consistently in docs

Browse Source 
Closes gh-970
This commit is contained in:
Madhura Bhave 2019-08-02 15:43:11 -07:00
parent f5427ffff4
commit 8e0f02887d
6 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.adoc
View File

@ -13,7 +13,7 @@ to generate and endpoints that you can use via plain HTTP.
Spring Initializr also exposes an endpoint that serves its metadata in a well-known
format to allow third-party clients to provide the necessary assistance.
Finally, Initializr offers a configuration structure to define all the aspects
Finally, Spring Initializr offers a configuration structure to define all the aspects
related to the project to generate: list of dependencies, supported java and boot
versions, etc. Check {service}[the companion project] that defines
https://start.spring.io and, in particular, the

2
initializr-docs/src/main/asciidoc/configuration-format.adoc
View File

@ -1,6 +1,6 @@
[[configuration-format]]
# Configuration Format
This section describes the configuration structure that is used by the initializr.
This section describes the configuration structure that is used by Spring initializr.
The metadata provided through configuration are driving the options exposed by a
particular instance and <<metadata-format.adoc#metadata-format,the project metadata
format>>.

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

@ -3,7 +3,7 @@
[partintro]
--
You can use Initializr to create your own service that can generate JVM projects.
You can use Spring Initializr to create your own service that can generate JVM projects.
This section describes how you can create your own service and tune it for
your needs, and also how you can configure an existing service.
--
@ -267,7 +267,7 @@ Each capability has a default value if nothing is configured. The defaults can b
=== Configuring available Spring Boot versions
If you look at http://projects.spring.io/spring-boot[the project home page for Spring
Boot], the latest versions are displayed. And you've probably noticed that they match the
drop down list that you automatically get with a default instance of the Initializr. The
drop down list that you automatically get with a default instance of Spring Initializr. The
reason for that is that Spring Initializr calls an API on https://spring.io to retrieve the
latest versions automatically. This makes sure that you always get the latest available
versions.
@ -536,10 +536,10 @@ ecosystem we usually use the suffix `-dependencies` on the artifact id of a BOM.
projects we see `-bom`. It is recommended that all dependencies are included in a BOM of
some sort, since they provide nice high level features for users of the dependency. It is
also important that 2 BOMs used in a project do not contain conflicting versions for the
same dependency, so the best practice is to look at the existing BOMs in the Initializr
same dependency, so the best practice is to look at the existing BOMs in Spring Initializr
before you add a new one, and make sure that you aren't adding a conflict.
In the Initializr a BOM is declared at the `env` level, and given an id through the
In Spring Initializr a BOM is declared at the `env` level, and given an id through the
configuration key. Example:
[source,yaml,indent=0]

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

@ -24,17 +24,17 @@ using the jars as libraries in your own app.
The API can be used standalone or embedded in other tools (e.g. it is used in major IDEs
such as Spring Tool Suite, IntelliJ IDEA Ultimate, Netbeans and VSCode).
You can easily create your own instance of the Initializr, by using the jars as libraries
You can easily create your own instance of the Spring Initializr, by using the jars as libraries
in your own app. There is minimal code involved and the service has a very rich
configuration structure, allowing you to define not only the values of various project
attributes but also the list of dependencies and the constraints to apply to them. If that
sounds interesting, then <<configuration-guide.adoc#configuration-guide>> has all the
details you need. You might only want to modify an existing instance of the Initializr,
details you need. You might only want to modify an existing instance of Spring Initializr,
e.g. to add a new dependency type, or update the version of an existing
one. For those and other simple and common use cases check out
<<configuration-guide.adoc#configuration-howto>>.
The Initializr also provides an extensible API to generate quickstart projects, and to
Spring 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 major IDEs such as Spring Tool Suite, IntelliJ IDEA Ultimate, Netbeans

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

@ -125,7 +125,7 @@ able to select that dependency.
[[getting-started-tuning-defaults]]
=== Tuning default values
The Initializr service is configured to offer default values so that you can generate a
A Spring Initializr service is configured to offer default values so that you can generate a
new project with minimum fuss. Maybe you are a Kotlin fan? Or a Gradle fan? Currently
start.spring.io defaults to Java and Maven but it also allows you to tune these defaults
easily.

10
initializr-docs/src/main/asciidoc/using-the-stubs.adoc
View File

@ -1,7 +1,7 @@
= Using the Stubs
The Initializr project publishes
Spring Initializr project publishes
https://github.com/tomakehurst/wiremock[WireMock] stubs for all the JSON responses
that are tested in the project. If you are writing a client for the Initializr
that are tested in the project. If you are writing a client for Spring Initializr
service, you can use these stubs to test your own code. You can consume them with the
raw Wiremock APIs, or via some features of
https://github.com/spring-cloud/spring-cloud-contract[Spring Cloud Contract].
@ -67,7 +67,7 @@ TIP: This dependency is managed by the `spring-cloud-contract-dependencies` BOM.
Alternatively you can configure the stub runner to look for the artifact, using a
different Spring Cloud Contract dependency:
`spring-cloud-starter-contract-stub-runner`. The example below will automatically
download, if necessary, the defined version of the initializr stubs (so you don't need the
download, if necessary, the defined version of the Spring Initializr stubs (so you don't need the
stubs declared as a dependency):
[source,xml,indent=0,subs="attributes,specialchars"]
@ -118,12 +118,12 @@ Then you have a server that returns the stub of the JSON metadata
The stubs are laid out in a jar file in a form (under "**/mappings") that can be consumed
by WireMock just by setting its file source. The names of the individual stubs are the
same as the method names of the test cases that generated them in the Initializr
same as the method names of the test cases that generated them in Spring Initializr
project. So for example there is a test case "metadataWithV2AcceptHeader" in
`MainControllerIntegrationTests` that makes assertions about the response when the accept
header is `application/vnd.initializr.v2.1+json`. The response is recorded in the stub,
and it will match in WireMock if the same headers and request parameters that were used in
the Initializr test case and used in the client. The method name usually summarizes what
Spring Initializr test case and used in the client. The method name usually summarizes what
those values are.
The stub runner, and the `@AutoConfigureWireMock` in the examples above loads all the