org.springframework.restdocs.hypermedia

Class HypermediaDocumentation

java.lang.Object

org.springframework.restdocs.hypermedia.HypermediaDocumentation

public abstract class HypermediaDocumentation
extends Object

Static factory methods for documenting a RESTful API that utilizes Hypermedia.

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
static LinkExtractor	atomLinks() Returns a LinkExtractor capable of extracting links in Atom format where the links are found in an array named links.
static LinkExtractor	halLinks() Returns a LinkExtractor capable of extracting links in Hypermedia Application Language (HAL) format where the links are found in a map named _links.
static Snippet	links(LinkDescriptor... descriptors) Returns a handler that will produce a snippet documenting the links in the API call's response.
static Snippet	links(LinkExtractor linkExtractor, LinkDescriptor... descriptors) Returns a handler that will produce a snippet documenting the links in the API call's response.
static Snippet	links(LinkExtractor linkExtractor, Map<String,Object> attributes, LinkDescriptor... descriptors) Returns a handler that will produce a snippet documenting the links in the API call's response.
static Snippet	links(Map<String,Object> attributes, LinkDescriptor... descriptors) Returns a handler that will produce a snippet documenting the links in the API call's response.
static LinkDescriptor	linkWithRel(String rel) Creates a LinkDescriptor that describes a link with the given rel.

Methods inherited from class java.lang.Object

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

Method Detail

linkWithRel

public static LinkDescriptor linkWithRel(String rel)

Creates a LinkDescriptor that describes a link with the given rel.

Parameters:

rel - The rel of the link

Returns:

a LinkDescriptor ready for further configuration

links

public static Snippet links(LinkDescriptor... descriptors)

Returns a handler that will produce a snippet documenting the links in the API call's response. Links will be extracted from the response automatically based on its content type.

Parameters:

descriptors - The descriptions of the response's links

Returns:

the handler

links

public static Snippet links(Map<String,Object> attributes,
                            LinkDescriptor... descriptors)

Returns a handler that will produce a snippet documenting the links in the API call's response. The given attributes will be available during snippet generation. Links will be extracted from the response automatically based on its content type.

Parameters:

attributes - Attributes made available during rendering of the links snippet

descriptors - The descriptions of the response's links

Returns:

the handler

links

public static Snippet links(LinkExtractor linkExtractor,
                            LinkDescriptor... descriptors)

Returns a handler that will produce a snippet documenting the links in the API call's response. Links will be extracted from the response using the given linkExtractor.

Parameters:

linkExtractor - Used to extract the links from the response

descriptors - The descriptions of the response's links

Returns:

the handler

links

public static Snippet links(LinkExtractor linkExtractor,
                            Map<String,Object> attributes,
                            LinkDescriptor... descriptors)

Returns a handler that will produce a snippet documenting the links in the API call's response. The given attributes will be available during snippet generation. Links will be extracted from the response using the given linkExtractor.

Parameters:

attributes - Attributes made available during rendering of the links snippet

linkExtractor - Used to extract the links from the response

descriptors - The descriptions of the response's links

Returns:

the handler

halLinks

public static LinkExtractor halLinks()

Returns a LinkExtractor capable of extracting links in Hypermedia Application Language (HAL) format where the links are found in a map named _links.

Returns:

The extract for HAL-style links

atomLinks

public static LinkExtractor atomLinks()

Returns a LinkExtractor capable of extracting links in Atom format where the links are found in an array named links.

Returns:

The extractor for Atom-style links