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 Snippet	curlRequest() Returns a handler that will produce a snippet containing the curl request for the API call.
static Snippet	curlRequest(Map<String,Object> attributes) Returns a handler that will produce a snippet containing the curl request for the API call.

Methods inherited from class java.lang.Object

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

Method Detail

curlRequest

public static Snippet curlRequest()

Returns a handler that will produce a snippet containing the curl request for the API call.

Returns:

the handler that will produce the snippet

curlRequest

public static Snippet curlRequest(Map<String,Object> attributes)

Returns a handler that will produce a snippet containing the curl request for the API call. The given attributes will be available during snippet generation.

Parameters:

attributes - Attributes made available during rendering of the curl request snippet

Returns:

the handler that will produce the snippet