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