RebrickableSharpダウンロード - RebrickableSharpソースコードのダウンロード

RebrickableSharp

その他のソースコード

ダウンロード

再煉瓦可能シャープ

導入

RebrickableSharp は、わずか数行のコードで開始できる、Rebrickable API 用の厳密に型指定された使いやすい C# クライアントです。認証、エラー処理、JSON の型付きインスタンスへの解析を処理します。 .NET 標準 2.0と互換性のあるすべての .NET プラットフォームをサポートします。

変更履歴

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

使用上の推奨事項

アプリケーションの存続期間中、1 つの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 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 ) ;