Demands — .NET клиент для API

Библиотека Demands предоставляет типизированный клиент для взаимодействия с API Demands. Целевая платформа — .NET Standard 2.0, что обеспечивает совместимость с .NET Framework 4.6.1+ и .NET Core 2.0+.

Установка

dotnet add package Demands

Или через Package Manager Console:

Install-Package Demands

Текущая версия пакета: 3.3.3.

Быстрый старт

Вариант 1 — прямое создание клиента

Используйте статический метод DemandsApi.Build, если вы не используете DI-контейнер (например, в консольных приложениях или скриптах):

using Demands;
using Demands.Contracts;

IDemandsApiClient client = DemandsApi.Build(options =>
{
    options.ConnectToHost("https://demands.example.com/");
    options.SetApplication("MyApp");
    options.SetAuthToken("my-auth-token");
});

IDemandsApiContext context = client.GetContext();
var profiles = await context.Profiles.GetProfiles();

Вариант 2 — регистрация через DI (ASP.NET Core / Generic Host)

Рекомендуемый способ для серверных приложений. Метод расширения AddDemandsApi регистрирует IDemandsApiClient и все зависимости в IServiceCollection:

using Demands.Common.Extensions;

services.AddDemandsApi(options =>
{
    options.ConnectToHost("https://demands.example.com/");
    options.SetApplication("MyApp");
    options.SetAuthToken("my-auth-token");
});

После регистрации IDemandsApiClient доступен через конструктор:

public class MyService
{
    private readonly IDemandsApiClient _client;

    public MyService(IDemandsApiClient client)
    {
        _client = client;
    }

    public async Task DoWork()
    {
        var context = _client.GetContext();
        var profiles = await context.Profiles.GetProfiles();
        context.SetProfile(profiles.First());
        var docs = await context.Documents.Search(new DocumentSearchOptionsApiDTO
        {
            ListType = DocumentListType.My
        });
    }
}

Обязательные параметры

Для работы клиента необходимо указать минимум три параметра:

Конфигурация

Все параметры задаются через DemandsApiOptionsBuilder:

Документация

• Использование — подробное руководство по настройке и использованию
• Справочник API — описание интерфейсов, DTO и перечислений
• Примеры — типовые сценарии использования
• Устранение неполадок — решение частых проблем

Лицензия

Проприетарная лицензия. Подробности уточняйте у владельца репозитория.