RebrickableSharp

อิฐซ้ำได้Sharp

การแนะนำ

RebrickableSharp เป็นไคลเอนต์ C# ที่พิมพ์ได้ชัดเจนและใช้งานง่ายสำหรับ Rebrickable API ซึ่งช่วยให้คุณเริ่มต้นด้วยโค้ดเพียงไม่กี่บรรทัด โดยจะจัดการการรับรองความถูกต้อง การจัดการข้อผิดพลาด และการแยกวิเคราะห์ 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> " ;

IRbrickableClient

 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 เป็นอินสแตนซ์เดี่ยว (ซิงเกิลตัน)

ตัวอย่างออโต้แฟค

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 ID

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