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

Document support for relaxed snippets

Browse Source 
Closes gh-223
This commit is contained in:
Andy Wilkinson
2016-05-05 14:47:03 +01:00
parent 60a02a431f
commit d362f3f41f
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -49,6 +49,11 @@ response and the link has not been marked as optional.
If you do not want to document a link, you can mark it as ignored. This will prevent it
from appearing in the generated snippet while avoiding the failure described above.
Links can also be documented in a relaxed mode where any undocumented links will not cause
a test failure. To do so, use the `relaxedLinks` method on
`org.springframework.restdocs.hypermedia.HypermediaDocumentation`. This can be useful when
documenting a particular scenario where you only want to focus on a subset of the links.
[[documenting-your-api-hypermedia-link-formats]]
@@ -144,6 +149,12 @@ treated as having been documented.
If you do not want to document a field, you can mark it as ignored. This will prevent it
from appearing in the generated snippet while avoiding the failure described above.
Fields can also be documented in a relaxed mode where any undocumented fields will not
cause a test failure. To do so, use the `relaxedRequestFields` and `relaxedResponseFields`
methods on
`org.springframework.restdocs.payload.PayloadDocumentation`. This can be useful when
documenting a particular scenario where you only want to focus on a subset of the payload.
TIP: By default, Spring REST Docs will assume that the payload you are documenting is
JSON. If you want to document an XML payload the content type of the request or response
must be compatible with `application/xml`.
@@ -454,6 +465,12 @@ If you do not want to document a request parameter, you can mark it as ignored.
prevent it from appearing in the generated snippet while avoiding the failure described
above.
Request parameters can also be documented in a relaxed mode where any undocumented
parameters will not cause a test failure. To do so, use the `relaxedRequestParameters`
method on `org.springframework.restdocs.request.RequestDocumentation`. This can be useful
when documenting a particular scenario where you only want to focus on a subset of the
request parameters.
[[documenting-your-api-path-parameters]]
@@ -498,6 +515,12 @@ When documenting path parameters, the test will fail if an undocumented path par
is used in the request. Similarly, the test will also fail if a documented path parameter
is not found in the request and the path parameter has not been marked as optional.
Path parameters can also be documented in a relaxed mode where any undocumented
parameters will not cause a test failure. To do so, use the `relaxedPathParameters`
method on `org.springframework.restdocs.request.RequestDocumentation`. This can be useful
when documenting a particular scenario where you only want to focus on a subset of the
path parameters.
If you do not want to document a path parameter, you can mark it as ignored. This will
prevent it from appearing in the generated snippet while avoiding the failure described
above.