C# Класс IO.Swagger.Client.ApiClient

API client is mainly responible for making the HTTP call to the API backend.
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
AddDefaultHeader ( string key, string value ) : void

Add default header.
ApiClient ( String basePath = "http://petstore.swagger.io/v2" ) : System

Initializes a new instance of the ApiClient class.
Base64Encode ( string text ) : string

Encode string in base64 format.
CallApi ( String path, RestSharp method, String>.Dictionary queryParams, String postBody, String>.Dictionary headerParams, String>.Dictionary formParams, FileParameter>.Dictionary fileParams, String authSettings ) : Object

Makes the HTTP request (Sync).
ConvertType ( Object source, Type dest ) : Object

Dynamically cast the object into target type. Ref: http://stackoverflow.com/questions/4925718/c-dynamic-runtime-cast
Deserialize ( string content, Type type, IList headers = null ) : object

Deserialize the JSON string into a proper object.
EscapeString ( string str ) : string

Escape string (url-encoded).
GetApiKeyWithPrefix ( string apiKeyIdentifier ) : string

Get the API key with prefix.
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 of string, join the list with ",". Otherwise just return the string.
Serialize ( object obj ) : string

Serialize an object into JSON string.
UpdateParamsForAuth ( String>.Dictionary queryParams, String>.Dictionary headerParams, string authSettings ) : void

Update parameters based on authentication.

Описание методов

AddDefaultHeader() публичный метод

Add default header.
public AddDefaultHeader ( string key, string value ) : void
key string Header field name.
value string Header field value.
Результат void

ApiClient() публичный метод

Initializes a new instance of the ApiClient class.
public ApiClient ( String basePath = "http://petstore.swagger.io/v2" ) : System
basePath String The base path.
Результат System

Base64Encode() публичный статический метод

Encode string in base64 format.
public static Base64Encode ( string text ) : string
text string String to be encoded.
Результат string

CallApi() публичный метод

Makes the HTTP request (Sync).
public CallApi ( String path, RestSharp method, String>.Dictionary queryParams, String postBody, String>.Dictionary headerParams, String>.Dictionary formParams, FileParameter>.Dictionary fileParams, String authSettings ) : Object
path String URL path.
method RestSharp HTTP method.
queryParams String>.Dictionary Query parameters.
postBody String HTTP body (POST request).
headerParams String>.Dictionary Header parameters.
formParams String>.Dictionary Form parameters.
fileParams FileParameter>.Dictionary File parameters.
authSettings String Authentication settings.
Результат Object

ConvertType() публичный статический метод

Dynamically cast the object into target type. Ref: http://stackoverflow.com/questions/4925718/c-dynamic-runtime-cast
public static ConvertType ( Object source, Type dest ) : Object
source Object Object to be casted
dest System.Type Target type
Результат Object

Deserialize() публичный метод

Deserialize the JSON string into a proper object.
public Deserialize ( string content, Type type, IList headers = null ) : object
content string HTTP body (e.g. string, JSON).
type System.Type Object type.
headers IList HTTP headers.
Результат object

EscapeString() публичный метод

Escape string (url-encoded).
public EscapeString ( string str ) : string
str string String to be escaped.
Результат string

GetApiKeyWithPrefix() публичный метод

Get the API key with prefix.
public GetApiKeyWithPrefix ( string apiKeyIdentifier ) : string
apiKeyIdentifier string API key identifier (authentication scheme).
Результат string

ParameterToFile() публичный метод

Create FileParameter based on Stream.
public ParameterToFile ( string name, Stream stream ) : FileParameter
name string Parameter name.
stream Stream Input stream.
Результат RestSharp.FileParameter

ParameterToString() публичный метод

If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime. If parameter is a list of string, join the list with ",". Otherwise just return the string.
public ParameterToString ( object obj ) : string
obj object The parameter (header, path, query, form).
Результат string

Serialize() публичный метод

Serialize an object into JSON string.
public Serialize ( object obj ) : string
obj object Object.
Результат string

UpdateParamsForAuth() публичный метод

Update parameters based on authentication.
public UpdateParamsForAuth ( String>.Dictionary queryParams, String>.Dictionary headerParams, string authSettings ) : void
queryParams String>.Dictionary Query parameters.
headerParams String>.Dictionary Header parameters.
authSettings string Authentication settings.
Результат void