Java org.springframework.restdocs.payload PayloadDocumentation fields, constructors, methods, implement or subclass

Example usage for Java org.springframework.restdocs.payload PayloadDocumentation fields, constructors, methods, implement or subclass

  1. HOME
  2. Java
  3. org.springframework
  4. org.springframework.restdocs.payload.*
  5. PayloadDocumentation

Introduction

In this page you can find the methods, fields and constructors for org.springframework.restdocs.payload PayloadDocumentation.

The text is from its open source code.

Method

FieldDescriptorfieldWithPath(String path)
Creates a FieldDescriptor that describes a field with the given path .
RequestFieldsSnippetrequestFields(FieldDescriptor... descriptors)
Returns a Snippet that will document the fields of the API operations's request payload.
RequestFieldsSnippetrequestFields(List descriptors)
Returns a Snippet that will document the fields of the API operations's request payload.
ResponseFieldsSnippetresponseFields(FieldDescriptor... descriptors)
Returns a Snippet that will document the fields of the API operation's response payload.
ResponseFieldsSnippetresponseFields(List descriptors)
Returns a Snippet that will document the fields of the API operation's response payload.
SubsectionDescriptorsubsectionWithPath(String path)
Creates a FieldDescriptor that describes a subsection, i.e.