Uses of Class
org.springframework.restdocs.payload.RequestPartBodySnippet
Package
Description
Documenting the payload of a RESTful API's requests and responses.
-
Uses of RequestPartBodySnippet in org.springframework.restdocs.payload
Modifier and TypeMethodDescriptionstatic RequestPartBodySnippet
PayloadDocumentation.requestPartBody
(String partName) Returns aSnippet
that will document the body of specified part of the API operation's request payload.static RequestPartBodySnippet
PayloadDocumentation.requestPartBody
(String partName, Map<String, Object> attributes) Returns aSnippet
that will document the body of specified part of the API operation's request payload.static RequestPartBodySnippet
PayloadDocumentation.requestPartBody
(String partName, PayloadSubsectionExtractor<?> subsectionExtractor) Returns aSnippet
that will document a subsection of the body of specified part of the API operation's request payload.static RequestPartBodySnippet
PayloadDocumentation.requestPartBody
(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Returns aSnippet
that will document a subsection of the body of specified part of the API operation's request payload.