Uses of Class
org.springframework.restdocs.payload.RequestBodySnippet
Packages that use RequestBodySnippet
Package
Description
Documenting the payload of a RESTful API's requests and responses.
-
Uses of RequestBodySnippet in org.springframework.restdocs.payload
Methods in org.springframework.restdocs.payload that return RequestBodySnippetModifier and TypeMethodDescriptionstatic RequestBodySnippet
PayloadDocumentation.requestBody()
Returns aSnippet
that will document the body of the API operation's request payload.static RequestBodySnippet
PayloadDocumentation.requestBody
(Map<String, Object> attributes) Returns aSnippet
that will document the body of the API operation's request payload.static RequestBodySnippet
PayloadDocumentation.requestBody
(PayloadSubsectionExtractor<?> subsectionExtractor) Returns aSnippet
that will document a subsection of the body of the API operation's request payload.static RequestBodySnippet
PayloadDocumentation.requestBody
(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Returns aSnippet
that will document a subsection of the body of the API operation's request payload.