Xbim.WexServer.Client 1.0.0

Xbim.WexServer.Client

👁 GitHub Packages
👁 License: MIT

A typed HTTP client for the Xbim Server API. Use this package to connect your BIM applications to Xbim Server for model storage, processing, and management. Auto-generated from OpenAPI/Swagger specifications using NSwag.

This package is required when using Xbim.WexBlazor in Platform mode (connected to Xbim Server). For standalone viewer applications without a backend, you only need Xbim.WexBlazor.

Features

• Typed API Client - Full IntelliSense support for all endpoints
• Authentication Support - Pluggable token provider for JWT authentication
• Resilience - Built-in retry policies and circuit breakers via Microsoft.Extensions.Http.Resilience
• HttpClientFactory - Proper HTTP client lifecycle management

Installation

# Add GitHub Packages source (one-time setup)
dotnet nuget add source https://nuget.pkg.github.com/Ibrahim5aad/index.json --name github --username YOUR_GITHUB_USERNAME --password YOUR_GITHUB_PAT

# Install the package
dotnet add package Xbim.WexServer.Client

Note: The YOUR_GITHUB_PAT needs read:packages scope. Create a PAT here.

Quick Start

Basic Setup

// Program.cs
builder.Services.AddWexServerClient(options =>
{
 options.BaseUrl = "https://your-Xbim-server.com";
});

With Authentication

Implement IAuthTokenProvider for your authentication flow:

public class MyTokenProvider : IAuthTokenProvider
{
 public Task<string?> GetTokenAsync(CancellationToken cancellationToken = default)
 {
 // Return your JWT token
 return Task.FromResult<string?>("your-jwt-token");
 }
}

Register with DI:

builder.Services.AddSingleton<IAuthTokenProvider, MyTokenProvider>();
builder.Services.AddWexServerClient(options =>
{
 options.BaseUrl = "https://your-Xbim-server.com";
});

Using the Client

@inject IXbimClient Client

// List workspaces
var workspaces = await Client.WorkspacesAllAsync();

// Create a project
var project = await Client.ProjectsPOSTAsync(new CreateProjectRequest
{
 Name = "My Project",
 WorkspaceId = workspaceId
});

// Upload a model
using var stream = File.OpenRead("model.ifc");
var file = await Client.UploadAsync(new FileParameter(stream, "model.ifc"));

// Get element properties
var properties = await Client.PropertiesAsync(modelVersionId, elementId);

API Endpoints

The client provides typed methods for all server endpoints:

Configuration Options

builder.Services.AddWexServerClient(options =>
{
 // Required: Server base URL
 options.BaseUrl = "https://api.example.com";

 // Optional: Request timeout (default: 30s)
 options.Timeout = TimeSpan.FromMinutes(2);
});

Manual Client Creation

For scenarios without DI:

var httpClient = new HttpClient
{
 BaseAddress = new Uri("https://your-server.com")
};

var client = new XbimClient(httpClient);
var workspaces = await client.WorkspacesAllAsync();

Regenerating the Client

If the server API changes, regenerate the client:

# Fetch latest swagger.json from running server
dotnet msbuild -t:FetchSwagger -p:ServerUrl=http://localhost:5000

# Regenerate client code
dotnet msbuild -t:RegenerateClient

# Or combined
dotnet msbuild -t:UpdateClient -p:ServerUrl=http://localhost:5000

Requirements

• .NET 9.0+
• Xbim Server instance

Dependencies

• Newtonsoft.Json - JSON serialization
• Microsoft.Extensions.Http - HttpClientFactory
• Microsoft.Extensions.Http.Resilience - Retry policies

License

MIT

Related Packages

• Xbim.WexBlazor - Blazor component library for 3D BIM visualization