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

使用推荐

建议在应用程序的整个生命周期中创建并使用一个IRebrickableClient客户端。

在使用 IoC 容器的应用程序中，您可以将IRebrickableClient注册为服务并将其注入到消费实例（例如控制器）中。请参阅以下示例将IRebrickableClient注册为单个实例 (Singleton)。

Autofac 示例

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