RebrickableSharp

RebrickableSharp

Introdução

RebrickableSharp é um cliente C# de tipo forte e fácil de usar para a API Rebrickable que permite começar com apenas algumas linhas de código. Ele lida com autenticação, tratamento de erros e análise de JSON em instâncias digitadas. Ele suporta todas as plataformas .NET compatíveis com o padrão .NET 2.0 .

Projetos relacionados

• BricklinkSharp - Cliente C# fácil de usar para a API do mercado bricklink (LEGO).

Registro de alterações

• Veja CHANGELOG.md

Comece

Projeto de demonstração

Confira o projeto de demonstração para exemplos completos.

Pré-requisitos

Você precisa ter uma conta no Rebrickable. Em seguida, vá para Conta > Configurações > API e crie uma nova chave ou use uma existente.

Observe que as classes auxiliares CSV não exigem o uso de uma chave de API.

Instalar o pacote NuGet

Console do gerenciador de pacotes

 Install-Package RebrickableSharp

Linha de Comando

 nuget install RebrickableSharp

Credenciais de configuração

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

IRebrickableCliente

 var client = RebrickableClientFactory . Build ( ) ;

// Do stuff

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

Alternativamente, um HttpClient gerenciado externamente pode ser usado:

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

// Do stuff

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

Recomendação de uso

É recomendado criar e usar um cliente IRebrickableClient durante toda a vida útil do seu aplicativo.

Em aplicações que usam um contêiner IoC você pode registrar o IRebrickableClient como um serviço e injetá-lo em instâncias de consumo (por exemplo, controladores). Veja os exemplos abaixo para registrar o IRebrickableClient como instância única (Singleton).

Exemplo de autofac

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

Exemplo de Microsoft.Extensions.DependencyInjection

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

Peças

Obtenha peças

 // 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 ; 

Encontre a peça por BrickLink ID

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

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

Obter cores das peças

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

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

Obtenha detalhes das cores das peças

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

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

Cores

Obter cores

 // 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 ; 

Obter cor

 // 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 ) ;

Elementos

Obter elemento

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

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

Minifiguras

 // 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 ) ;