org.springframework.restdocs.payload

Class PayloadDocumentation

java.lang.Object

org.springframework.restdocs.payload.PayloadDocumentation

public abstract class PayloadDocumentation
extends Object

Static factory methods for documenting a RESTful API's request and response payloads.

Author:

Andreas Evers, Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
static FieldSnippetResultHandler	documentRequestFields(String outputDir, FieldDescriptor... descriptors) Creates a RequestFieldsSnippetResultHandler that will produce a documentation snippet for a request's fields.
static FieldSnippetResultHandler	documentResponseFields(String outputDir, FieldDescriptor... descriptors) Creates a ResponseFieldsSnippetResultHandler that will produce a documentation snippet for a response's fields.
static FieldDescriptor	fieldWithPath(String path) Creates a FieldDescriptor that describes a field with the given path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fieldWithPath

public static FieldDescriptor fieldWithPath(String path)

Creates a FieldDescriptor that describes a field with the given path.

The path uses '.' to descend into a child object and ' []' to descend into an array. For example, with this JSON payload:

 {
    "a":{
        "b":[
            {
                "c":"one"
            },
            {
                "c":"two"
            },
            {
                "d":"three"
            }
        ]
    }
 }
 

The following paths are all present:

Path	Value
a	An object containing "b"
a.b	An array containing three objects
a.b[]	An array containing three objects
a.b[].c	An array containing the strings "one" and "two"
a.b[].d	The string "three"

Parameters:

path - The path of the field

Returns:

a FieldDescriptor ready for further configuration

See Also:

RestDocumentationResultHandler.withRequestFields(FieldDescriptor...), RestDocumentationResultHandler.withResponseFields(FieldDescriptor...)

documentRequestFields

public static FieldSnippetResultHandler documentRequestFields(String outputDir,
                                                              FieldDescriptor... descriptors)

Creates a RequestFieldsSnippetResultHandler that will produce a documentation snippet for a request's fields.

Parameters:

outputDir - The directory to which the snippet should be written

descriptors - The descriptions of the request's fields

Returns:

the handler

See Also:

RestDocumentationResultHandler.withRequestFields(FieldDescriptor...)

documentResponseFields

public static FieldSnippetResultHandler documentResponseFields(String outputDir,
                                                               FieldDescriptor... descriptors)

Creates a ResponseFieldsSnippetResultHandler that will produce a documentation snippet for a response's fields.

Parameters:

outputDir - The directory to which the snippet should be written

descriptors - The descriptions of the response's fields

Returns:

the handler

See Also:

RestDocumentationResultHandler.withResponseFields(FieldDescriptor...)