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

Document how to specify query parameters when testing with MockMvc

Browse Source 
Closes gh-926
This commit is contained in:
Andy Wilkinson
2024-05-07 15:51:13 +01:00
parent d4bb3b33c6
commit b6df3243b8
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/docs/asciidoc/documenting-your-api.adoc
View File

@@ -661,11 +661,13 @@ The following examples show how to do so:
include::{examples-dir}/com/example/mockmvc/QueryParameters.java[tags=query-parameters]
----
<1> Perform a `GET` request with two parameters, `page` and `per_page`, in the query string.
Query parameters should be included in the URL, as shown here, or specified using the request builder's `queryParam` or `queryParams` method.
The `param` and `params` methods should be avoided as the source of the parameters is then ambiguous.
<2> Configure Spring REST Docs to produce a snippet describing the request's query parameters.
Uses the static `queryParameters` method on `org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the `page` parameter.
<3> Document the `page` query parameter.
Uses the static `parameterWithName` method on `org.springframework.restdocs.request.RequestDocumentation`.
<4> Document the `per_page` parameter.
<4> Document the `per_page` query parameter.
[source,java,indent=0,role="secondary"]
.WebTestClient