org.springframework.restdocs.curl

Class CurlDocumentation

java.lang.Object

org.springframework.restdocs.curl.CurlDocumentation

Deprecated.

Since 1.1 in favor of CliDocumentation.

@Deprecated
public abstract class CurlDocumentation
extends java.lang.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() Deprecated. Since 1.1 in favor of CliDocumentation.curlRequest().
static Snippet	curlRequest(java.util.Map<java.lang.String,java.lang.Object> attributes) Deprecated. Since 1.1 in favor of CliDocumentation.curlRequest(Map).

Methods inherited from class java.lang.Object

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

Method Detail

curlRequest

@Deprecated
public static Snippet curlRequest()

Deprecated. Since 1.1 in favor of CliDocumentation.curlRequest().

Returns a new Snippet that will document the curl request for the API operation.

Returns:

the snippet that will document the curl request

curlRequest

@Deprecated
public static Snippet curlRequest(java.util.Map<java.lang.String,java.lang.Object> attributes)

Deprecated. Since 1.1 in favor of CliDocumentation.curlRequest(Map).

Returns a new Snippet that will document the curl request for the API operation. The given attributes will be available during snippet generation.

Parameters:

attributes - the attributes

Returns:

the snippet that will document the curl request