org.springframework.restdocs.curl

Class CurlDocumentation

java.lang.Object

org.springframework.restdocs.curl.CurlDocumentation

public abstract class CurlDocumentation
extends Object

Static factory methods for documenting a RESTful API as if it were being driven using the cURL command-line utility.

Author:

Andy Wilkinson, Yann Le Guern, Dmitriy Mayboroda, Jonathan Pearlin

Method Summary

Modifier and Type	Method and Description
static SnippetWritingResultHandler	documentCurlRequest(String outputDir) Produces a documentation snippet containing the request formatted as a cURL command

Methods inherited from class java.lang.Object

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

Method Detail

documentCurlRequest

public static SnippetWritingResultHandler documentCurlRequest(String outputDir)

Produces a documentation snippet containing the request formatted as a cURL command

Parameters:

outputDir - The directory to which snippet should be written

Returns:

the handler that will produce the snippet