Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in / Register
Toggle navigation
S
spring-boot
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DEMO
spring-boot
Commits
ce17a923
Commit
ce17a923
authored
Feb 27, 2019
by
Stephane Nicoll
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Polish contribution
Closes gh-15978
parent
cf89ebcf
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
26 additions
and
22 deletions
+26
-22
spring-boot-features.adoc
...ing-boot-docs/src/main/asciidoc/spring-boot-features.adoc
+22
-18
AdvancedConfigurationExample.java
...gure/restdocs/webclient/AdvancedConfigurationExample.java
+3
-2
UsersDocumentationTests.java
...configure/restdocs/webclient/UsersDocumentationTests.java
+1
-2
No files found.
spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
View file @
ce17a923
...
...
@@ -7695,6 +7695,28 @@ generate the default snippets. The following example shows a
[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-web-test-client]]
===== Auto-configured Spring REST Docs Tests with WebTestClient
`@AutoConfigureRestDocs` can also be used with `WebTestClient`. You can inject it by using
`@Autowired` and use it in your tests as you normally would when using `@WebFluxTest` and
Spring REST Docs, as shown in the following example:
[source,java,indent=0]
----
include::{code-examples}/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java[tag=source]
----
If you require more control over Spring REST Docs configuration than offered by the
attributes of `@AutoConfigureRestDocs`, you can use a
`RestDocsWebTestClientConfigurationCustomizer` bean, as shown in the following example:
[source,java,indent=0]
----
include::{code-examples}/test/autoconfigure/restdocs/webclient/AdvancedConfigurationExample.java[tag=configuration]
----
[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-rest-assured]]
===== Auto-configured Spring REST Docs Tests with REST Assured
`@AutoConfigureRestDocs` makes a `RequestSpecification` bean, preconfigured to use Spring
...
...
@@ -7716,25 +7738,7 @@ bean can be used, as shown in the following example:
include::{code-examples}/test/autoconfigure/restdocs/restassured/AdvancedConfigurationExample.java[tag=configuration]
----
[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-web-test-client]]
===== Auto-configured Spring REST Docs Tests with WebTestClient
`@AutoConfigureRestDocs` could be used in conjunction with a `@WebFluxTest` to generate REST Docs.
`@AutoConfigureRestDocs` customizes the `WebTestClient` bean to use Spring REST Docs. You can
inject it by using `@Autowired` and use it in your tests. Here is a quick sample:
[source,java,indent=0]
----
include::{code-examples}/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java[tag=source]
----
If you require more control over Spring REST Docs configuration than offered by the
attributes of `@AutoConfigureRestDocs`, you can use a
`RestDocsWebTestClientConfigurationCustomizer` bean, as shown in the following example:
[source,java,indent=0]
----
include::{code-examples}/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java[tag=configuration]
----
[[boot-features-testing-spring-boot-applications-testing-auto-configured-additional-auto-config]]
==== Additional Auto-configuration and Slicing
...
...
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/Advanced
RestDocsWebTestClient
ConfigurationExample.java
→
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedConfigurationExample.java
View file @
ce17a923
...
...
@@ -13,17 +13,18 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package
org
.
springframework
.
boot
.
docs
.
test
.
autoconfigure
.
restdocs
.
webclient
;
import
org.springframework.boot.test.autoconfigure.restdocs.RestDocsWebTestClientConfigurationCustomizer
;
import
org.springframework.boot.test.context.TestConfiguration
;
import
org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer
;
public
class
Advanced
RestDocsWebTestClient
ConfigurationExample
{
public
class
AdvancedConfigurationExample
{
// tag::configuration[]
@TestConfiguration
static
class
CustomizationConfiguration
public
static
class
CustomizationConfiguration
implements
RestDocsWebTestClientConfigurationCustomizer
{
@Override
...
...
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java
View file @
ce17a923
...
...
@@ -13,10 +13,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package
org
.
springframework
.
boot
.
docs
.
test
.
autoconfigure
.
restdocs
.
webclient
;
// tag::source[]
import
org.junit.jupiter.api.Test
;
import
org.junit.runner.RunWith
;
...
...
@@ -40,7 +40,6 @@ public class UsersDocumentationTests {
void
listUsers
()
{
this
.
webTestClient
.
get
().
uri
(
"/"
).
exchange
().
expectStatus
().
isOk
().
expectBody
()
.
consumeWith
(
document
(
"list-users"
));
}
}
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment