RestAliases.

Rest(ICakeContext, string, Uri, IDictionary<string, string>, string, string, Stream, Action<Stream>) Method

Summary

Sends a REST request and receives its response.
Assembly
Cake.Rest.dll
Namespace
Cake.Rest
Containing Type
RestAliases

Syntax

public static IRestResponse Rest(this ICakeContext context, string method, Uri endpoint, IDictionary<string, string> headers, string contentType, string fileName, Stream bodyStream, Action<Stream> responseWriter)

Attributes

Type Description
CakeMethodAliasAttribute
CakeNamespaceImportAttribute
CakeNamespaceImportAttribute
CakeNamespaceImportAttribute

Parameters

Name Type Description
context ICakeContext Cake build context
method string HTTP method
endpoint Uri Endpoint local address, starting with /
headers IDictionary<string, string> HTTP headers, null for no headers
contentType string MIME type of file included in body, use "application/octet-stream" if unsure.
fileName string Name of the file included in body, only for Content-Disposition header.
bodyStream Stream Stream of request body contents
responseWriter Action<Stream> Lambda function for reading response and writing to desired place.

Return Value

Type Description
IRestResponse REST response