Skip to content

Mention spring-restdocs-webtestclient as an alternative dependency in getting started documentation #654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Mention spring-restdocs-webtestclient as an alternative dependency in getting started documentation #654

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5aec83d
Update getting-started.adoc
LichKing-lee Oct 24, 2019
753d9c1
Update getting-started.adoc
LichKing-lee Oct 24, 2019
312e740
Update getting-started.adoc
LichKing-lee Oct 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/src/docs/asciidoc/getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ the configuration are described in the following listings:
</plugins>
</build>
----
<1> Add a dependency on `spring-restdocs-mockmvc` in the `test` scope. If you want to use
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one should stay as "test scope" as it's Maven.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops. i understand. my mistake sorry.

<1> Add a dependency on `spring-restdocs-mockmvc` in the `testCompile` configuration. If you want to use
`WebTestClient` or REST Assured rather than MockMvc, add a dependency on
`spring-restdocs-webtestclient` or `spring-restdocs-restassured` respectively instead.
<2> Add the Asciidoctor plugin.
Expand Down Expand Up @@ -172,9 +172,9 @@ the configuration are described in the following listings:
This will automatically configure the `snippets` attribute for use in your `.adoc`
files to point to `build/generated-snippets`. It will also allow you to use the
`operation` block macro.
<3> Add a dependency on `spring-restdocs-mockmvc` in the `testCompile` configuration. If
you want to use REST Assured rather than MockMvc, add a dependency on
`spring-restdocs-restassured` instead.
<3> Add a dependency on `spring-restdocs-mockmvc` in the `testCompile` configuration. If you want to use
`WebTestClient` or REST Assured rather than MockMvc, add a dependency on
`spring-restdocs-webtestclient` or `spring-restdocs-restassured` respectively instead.
<4> Configure a property to define the output location for generated snippets.
<5> Configure the `test` task to add the snippets directory as an output.
<6> Configure the `asciidoctor` task
Expand Down