Package org.springframework.restdocs.payload
@NullMarked
package org.springframework.restdocs.payload
Documenting the payload of a RESTful API's requests and responses.
-
ClassDescriptionAbstract
TemplatedSnippetsubclass that provides a base for snippets that document a RESTful resource's request or response body.AbstractTemplatedSnippetsubclass that provides a base for snippets that document a RESTful resource's request or response fields.A description of a field found in a request or response payload.AFieldDoesNotExistExceptionis thrown when a requested field does not exist in a payload.APayloadSubsectionExtractorthat extracts the subsection of the JSON payload identified by a field path.AFieldTypeRequiredExceptionis thrown when a field's type cannot be determined automatically and, therefore, must be explicitly provided.Resolves the type of a field in a request or response payload.An enumeration of the possible types for a field in a JSON request or response payload.Static factory methods for documenting a RESTful API's request and response payloads.PayloadSubsectionExtractor<T extends PayloadSubsectionExtractor<T>>Strategy interface for extracting a subsection of a payload.ASnippetthat documents the body of a request.ASnippetthat documents the fields in a request.ASnippetthat documents the body of a request part.ASnippetthat documents the fields in a request part.ASnippetthat documents the body of a response.ASnippetthat documents the fields in a response.A description of a subsection, i.e.