Skip to content

Latest commit

 

History

History
552 lines (513 loc) · 30.3 KB

README.md

File metadata and controls

552 lines (513 loc) · 30.3 KB
Raw

Build NuGet Version and Downloads count

DragonflySchema - the C# library for the Dragonfly Model Schema

Documentation for Dragonfly model schema

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

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.5

Dependencies

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 RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

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 DragonflySchema.Api;
using DragonflySchema.Client;
using DragonflySchema.Model;

Packaging

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 DragonflySchema.csproj

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

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using DragonflySchema.Api;
using DragonflySchema.Client;
using DragonflySchema.Model;

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

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.