C# Class DocRaptor.Client.ApiClient

API client is mainly responible for making the HTTP call to the API backend.

ファイルを表示 Open project: DocRaptor/docraptor-csharp Class Usage Examples

Public Methods

Method	Description
ApiClient ( ) : System	Initializes a new instance of the ApiClient class with default configuration and base path (https://docraptor.com/).
ApiClient ( Configuration config = null ) : System	Initializes a new instance of the ApiClient class with default base path (https://docraptor.com/).
ApiClient ( String basePath = "https://docraptor.com/" ) : System	Initializes a new instance of the ApiClient class with default configuration.
Base64Encode ( string text ) : string	Encode string in base64 format.
CallApi ( String path, RestSharp method, String>.Dictionary queryParams, Object postBody, String>.Dictionary headerParams, String>.Dictionary formParams, FileParameter>.Dictionary fileParams, String>.Dictionary pathParams, String contentType ) : Object	Makes the HTTP request (Sync).
CallApiAsync ( String path, RestSharp method, String>.Dictionary queryParams, Object postBody, String>.Dictionary headerParams, String>.Dictionary formParams, FileParameter>.Dictionary fileParams, String>.Dictionary pathParams, String contentType ) : System.Threading.Tasks.Task	Makes the asynchronous HTTP request.
ConvertType ( dynamic source, Type dest ) : dynamic	Dynamically cast the object into target type. Ref: http://stackoverflow.com/questions/4925718/c-dynamic-runtime-cast
Deserialize ( IRestResponse response, Type type ) : object	Deserialize the JSON string into a proper object.
EscapeString ( string str ) : string	Escape string (url-encoded).
ParameterToFile ( string name, Stream stream ) : FileParameter	Create FileParameter based on Stream.
ParameterToString ( object obj ) : string	If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime. If parameter is a list, join the list with ",". Otherwise just return the string.
ReadAsBytes ( Stream input ) : byte[]	Convert stream to byte array Credit/Ref: http://stackoverflow.com/a/221941/677735
SanitizeFilename ( string filename ) : string	Sanitize filename by removing the path
SelectHeaderAccept ( String accepts ) : String	Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)
SelectHeaderContentType ( String contentTypes ) : String	Select the Content-Type header's value from the given content-type array: if JSON exists in the given array, use it; otherwise use the first one defined in 'consumes'
Serialize ( object obj ) : String	Serialize an input (model) into JSON string
UrlEncode ( string input ) : string	URL encode a string Credit/Ref: https://github.com/restsharp/RestSharp/blob/master/RestSharp/Extensions/StringExtensions.cs#L50

Private Methods

Method	Description
PrepareRequest ( String path, RestSharp method, String>.Dictionary queryParams, Object postBody, String>.Dictionary headerParams, String>.Dictionary formParams, FileParameter>.Dictionary fileParams, String>.Dictionary pathParams, String contentType ) : RestRequest

Method Details

ApiClient() public method

Initializes a new instance of the ApiClient class with default configuration and base path (https://docraptor.com/).

public ApiClient ( ) : System
return	System

ApiClient() public method

Initializes a new instance of the ApiClient class with default base path (https://docraptor.com/).

public ApiClient ( Configuration config = null ) : System
config	Configuration	An instance of Configuration.
return	System

ApiClient() public method

Initializes a new instance of the ApiClient class with default configuration.

public ApiClient ( String basePath = "https://docraptor.com/" ) : System
basePath	String	The base path.
return	System

Base64Encode() public static method

Encode string in base64 format.

public static Base64Encode ( string text ) : string
text	string	String to be encoded.
return	string

CallApi() public method

Makes the HTTP request (Sync).

public CallApi ( String path, RestSharp method, String>.Dictionary queryParams, Object postBody, String>.Dictionary headerParams, String>.Dictionary formParams, FileParameter>.Dictionary fileParams, String>.Dictionary pathParams, String contentType ) : Object
path	String	URL path.
method	RestSharp	HTTP method.
queryParams	String>.Dictionary	Query parameters.
postBody	Object	HTTP body (POST request).
headerParams	String>.Dictionary	Header parameters.
formParams	String>.Dictionary	Form parameters.
fileParams	FileParameter>.Dictionary	File parameters.
pathParams	String>.Dictionary	Path parameters.
contentType	String	Content Type of the request
return	Object

CallApiAsync() public method

Makes the asynchronous HTTP request.

public CallApiAsync ( String path, RestSharp method, String>.Dictionary queryParams, Object postBody, String>.Dictionary headerParams, String>.Dictionary formParams, FileParameter>.Dictionary fileParams, String>.Dictionary pathParams, String contentType ) : System.Threading.Tasks.Task
path	String	URL path.
method	RestSharp	HTTP method.
queryParams	String>.Dictionary	Query parameters.
postBody	Object	HTTP body (POST request).
headerParams	String>.Dictionary	Header parameters.
formParams	String>.Dictionary	Form parameters.
fileParams	FileParameter>.Dictionary	File parameters.
pathParams	String>.Dictionary	Path parameters.
contentType	String	Content type.
return	System.Threading.Tasks.Task

ConvertType() public static method

Dynamically cast the object into target type. Ref: http://stackoverflow.com/questions/4925718/c-dynamic-runtime-cast

public static ConvertType ( dynamic source, Type dest ) : dynamic
source	dynamic	Object to be casted
dest	System.Type	Target type
return	dynamic

Deserialize() public method

Deserialize the JSON string into a proper object.

public Deserialize ( IRestResponse response, Type type ) : object
response	IRestResponse	The HTTP response.
type	System.Type	Object type.
return	object

EscapeString() public method

Escape string (url-encoded).

public EscapeString ( string str ) : string
str	string	String to be escaped.
return	string

ParameterToFile() public method

Create FileParameter based on Stream.

public ParameterToFile ( string name, Stream stream ) : FileParameter
name	string	Parameter name.
stream	Stream	Input stream.
return	RestSharp.FileParameter

ParameterToString() public method

If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime. If parameter is a list, join the list with ",". Otherwise just return the string.

public ParameterToString ( object obj ) : string
obj	object	The parameter (header, path, query, form).
return	string

ReadAsBytes() public static method

Convert stream to byte array Credit/Ref: http://stackoverflow.com/a/221941/677735

public static ReadAsBytes ( Stream input ) : byte[]
input	Stream	Input stream to be converted
return	byte[]

SanitizeFilename() public static method

Sanitize filename by removing the path

public static SanitizeFilename ( string filename ) : string
filename	string	Filename
return	string

SelectHeaderAccept() public method

Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)

public SelectHeaderAccept ( String accepts ) : String
accepts	String	The accepts array to select from.
return	String

SelectHeaderContentType() public method

Select the Content-Type header's value from the given content-type array: if JSON exists in the given array, use it; otherwise use the first one defined in 'consumes'

public SelectHeaderContentType ( String contentTypes ) : String
contentTypes	String	The Content-Type array to select from.
return	String

Serialize() public method

Serialize an input (model) into JSON string

public Serialize ( object obj ) : String
obj	object	Object.
return	String

UrlEncode() public static method

URL encode a string Credit/Ref: https://github.com/restsharp/RestSharp/blob/master/RestSharp/Extensions/StringExtensions.cs#L50

public static UrlEncode ( string input ) : string
input	string	String to be URL encoded
return	string