Package | Description |
---|---|
org.springframework.restdocs.payload |
Documenting the payload of a RESTful API's requests and responses.
|
Modifier and Type | Method and Description |
---|---|
static RequestPartBodySnippet |
PayloadDocumentation.requestPartBody(java.lang.String partName)
Returns a
Snippet that will document the body of specified part of the API
operation's request payload. |
static RequestPartBodySnippet |
PayloadDocumentation.requestPartBody(java.lang.String partName,
java.util.Map<java.lang.String,java.lang.Object> attributes)
Returns a
Snippet that will document the body of specified part of the API
operation's request payload. |
static RequestPartBodySnippet |
PayloadDocumentation.requestPartBody(java.lang.String partName,
PayloadSubsectionExtractor<?> subsectionExtractor)
Returns a
Snippet that will document a subsection of the body of specified
part of the API operation's request payload. |
static RequestPartBodySnippet |
PayloadDocumentation.requestPartBody(java.lang.String partName,
PayloadSubsectionExtractor<?> subsectionExtractor,
java.util.Map<java.lang.String,java.lang.Object> attributes)
Returns a
Snippet that will document a subsection of the body of specified
part of the API operation's request payload. |