org.springframework.restdocs.http

Class HttpDocumentation

java.lang.Object

org.springframework.restdocs.http.HttpDocumentation

public abstract class HttpDocumentation
extends Object

Static factory methods for documenting a RESTful API's HTTP requests.

Author:

Andy Wilkinson, Jonathan Pearlin

Method Summary

Modifier and Type	Method and Description
static SnippetWritingResultHandler	documentHttpRequest(String outputDir) Produces a documentation snippet containing the request formatted as an HTTP request
static SnippetWritingResultHandler	documentHttpResponse(String outputDir) Produces a documentation snippet containing the response formatted as the HTTP response sent by the server

Methods inherited from class java.lang.Object

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

Method Detail

documentHttpRequest

public static SnippetWritingResultHandler documentHttpRequest(String outputDir)

Produces a documentation snippet containing the request formatted as an HTTP request

Parameters:

outputDir - The directory to which snippet should be written

Returns:

the handler that will produce the snippet

documentHttpResponse

public static SnippetWritingResultHandler documentHttpResponse(String outputDir)

Produces a documentation snippet containing the response formatted as the HTTP response sent by the server

Parameters:

outputDir - The directory to which snippet should be written

Returns:

the handler that will produce the snippet