Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation after removal of deprecated REST Assured 2 support

Browse Source 
See gh-387 and 6986cb75
This commit is contained in:
Andy Wilkinson
2017-05-19 17:36:30 +02:00
parent 0e6e785fb0
commit 84f8e55101
2 changed files with 6 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/src/docs/asciidoc/getting-started.adoc
View File

@@ -171,8 +171,7 @@ the configuration are described below.
`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` and `com.jayway.restassured:restassured` (REST Assured
2) or `io.rest-assured:rest-assured` (REST Assured 3) instead.
`spring-restdocs-restassured` 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
@@ -321,8 +320,7 @@ include::{examples-dir}/com/example/restassured/ExampleApplicationTests.java[tag
<1> REST Assured is configured by adding a `RestAssuredRestDocumentationConfigurer` as a
`Filter`. An instance of this class can be obtained from the static
`documentationConfiguration()` method on `RestAssuredRestDocumentation` in the
`org.springframework.restdocs.restassured` or `org.springframework.restdocs.restassured3`
package depending on the version of REST Assured that you are using.
`org.springframework.restdocs.restassured3` package.
The configurer applies sensible defaults and also provides an API for customizing the
configuration. Refer to the <<configuration, configuration section>> for more information.
@@ -462,8 +460,7 @@ include::{examples-dir}/com/example/restassured/InvokeService.java[tags=invoke-s
that will be located beneath the configured output directory. The snippets are written by
a `RestDocumentationFilter`. An instance of this class can be obtained from the
static `document` method on `RestAssuredRestDocumentation` in the
`org.springframework.restdocs.restassured` or `org.springframework.restdocs.restassured3`
package depending on the version of REST Assured that you are using.
`org.springframework.restdocs.restassured3` package.
<4> Invoke the root (`/`) of the service.
<5> Assert that the service produce the expected response.

6
docs/src/docs/asciidoc/introduction.adoc
View File

@@ -12,9 +12,9 @@ can also be configured to use Markdown.
Spring REST Docs makes use of snippets produced by tests written with
{spring-framework-docs}/#spring-mvc-test-framework[Spring MVC Test] or
http://www.rest-assured.io[REST Assured] 2 and 3. This test-driven approach helps to
guarantee the accuracy of your service's documentation. If a snippet is incorrect the
test that produces it will fail.
http://www.rest-assured.io[REST Assured 3]. This test-driven approach helps to guarantee
the accuracy of your service's documentation. If a snippet is incorrect the test that
produces it will fail.
Documenting a RESTful service is largely about describing its resources. Two key parts
of each resource's description are the details of the HTTP requests that it consumes