RebrickableSharp

Dapat direbrick Tajam

Perkenalan

RebrickableSharp adalah klien C# yang diketik dengan kuat dan mudah digunakan untuk Rebrickable API yang membantu Anda memulai hanya dengan beberapa baris kode. Ini menangani otentikasi, penanganan kesalahan dan penguraian JSON ke dalam contoh yang diketik. Ini mendukung semua platform .NET yang kompatibel dengan .NET standar 2.0 .

Proyek terkait

• BricklinkSharp - Klien C# yang mudah digunakan untuk API pasar bricklink (LEGO).

log perubahan

• Lihat CHANGELOG.md

Memulai

Proyek Demo

Lihat proyek demo untuk contoh fitur lengkap.

Prasyarat

Anda harus memiliki akun di Rebrickable. Lalu, buka Akun > Pengaturan > API dan buat Kunci baru atau gunakan yang sudah ada.

Perhatikan bahwa kelas pembantu CSV tidak memerlukan Kunci API untuk digunakan.

Instal Paket NuGet

Konsol Manajer Paket

 Install-Package RebrickableSharp

Baris Perintah

 nuget install RebrickableSharp

Siapkan kredensial

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

Klien yang Dapat Diperbaiki

 var client = RebrickableClientFactory . Build ( ) ;

// Do stuff

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

Alternatifnya, HttpClient yang dikelola secara eksternal dapat digunakan:

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

// Do stuff

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

Rekomendasi penggunaan

Disarankan untuk membuat dan menggunakan satu klien IRebrickableClient sepanjang masa pakai aplikasi Anda.

Dalam aplikasi yang menggunakan kontainer IoC, Anda dapat mendaftarkan IRebrickableClient sebagai layanan dan memasukkannya ke dalam instance yang digunakan (misalnya pengontrol). Lihat contoh di bawah ini untuk mendaftarkan IRebrickableClient sebagai instance tunggal (Singleton).

Contoh faks otomatis

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

Contoh Microsoft.Extensions.DependencyInjection

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

Bagian

Dapatkan suku cadang

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

Temukan bagian berdasarkan BrickLink ID

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

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

Dapatkan warna bagian

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

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

Dapatkan detail warna bagian

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

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

Warna

Dapatkan warna

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

Dapatkan warna

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

Elemen

Dapatkan elemen

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

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

Minifig

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