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 utilises Hypermedia.

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
static LinkSnippetResultHandler	documentLinks(String outputDir, LinkExtractor linkExtractor, LinkDescriptor... descriptors) Creates a LinkSnippetResultHandler that will produce a documentation snippet for a response's links.
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

See Also:

RestDocumentationResultHandler.withLinks(LinkDescriptor...), RestDocumentationResultHandler.withLinks(LinkExtractor, LinkDescriptor...)

documentLinks

public static LinkSnippetResultHandler documentLinks(String outputDir,
                                                     LinkExtractor linkExtractor,
                                                     LinkDescriptor... descriptors)

Creates a LinkSnippetResultHandler that will produce a documentation snippet for a response's links.

Parameters:

outputDir - The directory to which the snippet should be written

linkExtractor - Used to extract the links from the response

descriptors - The descriptions of the response's links

Returns:

the handler

See Also:

RestDocumentationResultHandler.withLinks(LinkDescriptor...), RestDocumentationResultHandler.withLinks(LinkExtractor, LinkDescriptor...)