RebrickableSharp

RebrickableОстрый

Введение

RebrickableSharp — это строго типизированный и простой в использовании клиент C# для API Rebrickable, который позволяет начать работу с помощью всего лишь нескольких строк кода. Он занимается аутентификацией, обработкой ошибок и синтаксическим анализом JSON в типизированные экземпляры. Он поддерживает все платформы .NET, совместимые со стандартом .NET 2.0 .

Связанные проекты

• BricklinkSharp — простой в использовании клиент C# для API торговой площадки Bricklink (LEGO).

Журнал изменений

• См. CHANGELOG.md.

Начать

Демо-проект

Ознакомьтесь с демо-проектом, чтобы увидеть полнофункциональные примеры.

Предварительные условия

Вам необходимо иметь учетную запись на Rebrickable. Затем перейдите в «Учетная запись» > «Настройки» > «API» и создайте новый ключ или используйте существующий.

Обратите внимание, что вспомогательные классы CSV не требуют использования ключа API.

Установить пакет NuGet

Консоль диспетчера пакетов

 Install-Package RebrickableSharp

Командная строка

 nuget install RebrickableSharp

Учетные данные настройки

RebrickableClientConfiguration . Instance . ApiKey = " <Your API Key> " ;

IRebrickableClient

 var client = RebrickableClientFactory . Build ( ) ;

// Do stuff

// Client must be disposed properly
client . Dispose ( ) ;

В качестве альтернативы можно использовать HttpClient, управляемый извне :

 var httpClient = new HttpClient ( ) ;
var client = RebrickableClientFactory . Build ( httpClient ) ;

// Do stuff

// Client *and* HttpClient must be disposed properly
client . Dispose ( ) ;
httpClient . Dispose ( ) ; 

Рекомендации по использованию

Рекомендуется создать и использовать один клиент IRebrickableClient на протяжении всего времени существования вашего приложения.

В приложениях, использующих контейнер IoC, вы можете зарегистрировать IRebrickableClient как службу и внедрить ее в потребляющие экземпляры (например, контроллеры). См. приведенные ниже примеры, чтобы зарегистрировать IRebrickableClient как отдельный экземпляр (Singleton).

Пример автофака

containerBuilder . Register ( c => RebrickableClientFactory . Build ( ) )
	. As < IRebrickableClient > ( )
	. SingleInstance ( ) ; 

Пример Microsoft.Extensions.DependencyInjection

services . AddSingleton ( typeof ( IRebrickableClient ) , provider =>
{
    return RebrickableClientFactory . Build ( ) ;
} ) ;  

Части

Получить детали

 // API
Task < PagedResponse < Part > > GetPartsAsync ( int page = 1 , int pageSize = 100 , 
    bool includeDetails = false , string ? bricklinkId = null ,
    string ? partNumber = null , IEnumerable < string > ? partNumbers = null ,
    int ? categoryId = null , string ? brickOwlId = null ,
    string ? legoId = null , string ? lDrawId = null ,
    string ? searchTerm = null ,
    CancellationToken cancellationToken = default ) ; 

 // Example
var response = await client . GetPartsAsync ( page : 1 , pageSize : 50 , includeDetails : true , searchTerm : " M-Tron " ) ;
var parts = response . Results ; 

Найти деталь по идентификатору BrickLink

 // API
Task < Part ? > FindPartByBricklinkIdAsync ( string bricklinkId ,
    bool includeDetails = false ,
    CancellationToken cancellationToken = default ) ; 

 // Example
var part = await client . FindPartByBricklinkIdAsync ( " 3005 " , true ) ; 

Получить цвета деталей

 // API
Task < PagedResponse < PartColor > > GetPartColorsAsync ( string partNumber ,
    RebrickableCredentials ? credentials = null ,
    CancellationToken cancellationToken = default ) ; 

 // Example
var pagedResult = await client . GetPartColorDetailsAsync ( " 3003 " ) ;
var partColors = pagedResult . Results ; 

Получить информацию о цвете детали

 // API
Task < PartColorDetails > GetPartColorDetailsAsync ( string partNumber , int colorId ,
    CancellationToken cancellationToken = default ) ; 

 // Example
var colorId = 1 ; //Blue
var partColorDetails = await client . GetPartColorDetailsAsync ( " 3005 " , colorId )

Цвета

Получить цвета

 // API
Task < PagedResponse < Color > > GetColorsAsync ( int page = 1 , int pageSize = 100 ,
    bool includeDetails = false ,
    CancellationToken cancellationToken = default ) ; 

 // Example
var response = await client . GetColorsAsync ( includeDetails : true ,
    page : 1 , pageSize : 50 ) ;
var colors = response . Results ; 

Получить цвет

 // API
Task < Color > GetColorAsync ( int colorId , bool includeDetails = false , 
    CancellationToken cancellationToken = default ) ; 

 // Example
var colorId = 0 ; //black
var black = await client . GetColorAsync ( colorId , includeDetails : true ) ;

Элементы

Получить элемент

 // API
Task < Element > GetElementAsync ( string elementId , 
    CancellationToken cancellationToken = default ) ;  

 // Example
var elementId = " 300521 " ; //1x1 Brick in Red
var element = await client . GetElementAsync ( elementId ) ;

Минифигурки

 // API
Task < Minifig > GetMinifigByIdAsync (
    string minifigId ,
    RebrickableCredentials ? credentials = null ,
    CancellationToken cancellationToken = default ) ; 

 // Example
var minifigId = " fig-000001 " ; //Toy Store Employee, note that minifigId is named 'set_num' in the API docs.
var minifig = await client . GetMinifigByIdAsync ( minifigId ) ;