Class ResponseBodySnippet

java.lang.Object
org.springframework.restdocs.snippet.TemplatedSnippet
org.springframework.restdocs.payload.AbstractBodySnippet
org.springframework.restdocs.payload.ResponseBodySnippet
All Implemented Interfaces:
Snippet
public class ResponseBodySnippet extends AbstractBodySnippet
A Snippet that documents the body of a response.
Author:
Andy Wilkinson

  • Constructor Details

    • ResponseBodySnippet

      public ResponseBodySnippet()
      Creates a new ResponseBodySnippet.

    • ResponseBodySnippet

      public ResponseBodySnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor)
      Creates a new ResponseBodySnippet that will document the subsection of the response body extracted by the given subsectionExtractor. If the extractor is null the entire response body will be documented.
      Parameters:
      subsectionExtractor - the subsection extractor, or null to document the entire response body

    • ResponseBodySnippet

      public ResponseBodySnippet(@Nullable Map<String,Object> attributes)
      Creates a new ResponseBodySnippet with the given additional attributes that will be included in the model during template rendering.
      Parameters:
      attributes - the additional attributes

    • ResponseBodySnippet

      public ResponseBodySnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor, @Nullable Map<String,Object> attributes)
      Creates a new ResponseBodySnippet that will document the subsection of the response body extracted by the given subsectionExtractor. If the extractor is null the entire response body will be documented. The given additional attributes that will be included in the model during template rendering.
      Parameters:
      subsectionExtractor - the subsection extractor, or null to document the entire response body
      attributes - the additional attributes

  • Method Details

    • getContent

      protected byte[] getContent(Operation operation) throws IOException
      Description copied from class: AbstractBodySnippet
      Returns the content of the request or response extracted from the given operation.
      Specified by:
      getContent in class AbstractBodySnippet
      Parameters:
      operation - the operation
      Returns:
      the content
      Throws:
      IOException - if the content cannot be extracted

    • getContentType

      protected @Nullable org.springframework.http.MediaType getContentType(Operation operation)
      Description copied from class: AbstractBodySnippet
      Returns the content type of the request or response extracted from the given operation.
      Specified by:
      getContentType in class AbstractBodySnippet
      Parameters:
      operation - the operation
      Returns:
      the content type