Push API resources Open API documentation

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• SDK version: 0.0.2
• Generator version: 7.6.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen

• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Databox.Api;
using Databox.Client;
using Databox.Model;

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Databox.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http:https://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Each ApiClass (properly the ApiClient inside it) will create an instance of HttpClient. It will use that for the entire lifecycle and dispose it when called the Dispose method.

To better manager the connections it's a common practice to reuse the HttpClient and HttpClientHandler (see here for details). To use your own HttpClient instance just pass it to the ApiClass constructor.

HttpClientHandler yourHandler = new HttpClientHandler();
HttpClient yourHttpClient = new HttpClient(yourHandler);
var api = new YourApiClass(yourHttpClient, yourHandler);

If you want to use an HttpClient and don't have access to the handler, for example in a DI context in Asp.net Core when using IHttpClientFactory.

HttpClient yourHttpClient = new HttpClient();
var api = new YourApiClass(yourHttpClient);

You'll loose some configuration settings, the features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings. You need to either manually handle those in your setup of the HttpClient or they won't be available.

Here an example of DI setup in a sample web project:

services.AddHttpClient<YourApiClass>(httpClient =>
   new PetApi(httpClient));

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Databox.Api;
using Databox.Client;
using Databox.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http:https://localhost:8080/q/openapi";
            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new DefaultApi(httpClient, config, httpClientHandler);
            var payloadModel = new PayloadModel?(); // PayloadModel? |  (optional) 

            try
            {
                apiInstance.RootPost(payloadModel);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DefaultApi.RootPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

All URIs are relative to http:https://localhost:8080/q/openapi

• Model.ApiResponse
• Model.PayloadDataModel
• Model.PayloadModel

Authentication schemes defined for the API:

• Type: HTTP basic authentication