DbgCensus.Rest 1.0.3

<img title="DbgCensus Icon" alt="DbgCensus Icon" src="https://github.com/carlst99/DbgCensus/blob/main/Assets/Icon_128.png?raw=true" align="left"></img>

DbgCensus

DbgCensus is a C# wrapper for Daybreak Game Company's Census API. It was built with PlanetSide 2's endpoints in mind, but should work across all namespaces.

This package is unofficial and is not affiliated with Daybreak Games Company in any way.

- Core data types and utilities.
- Services for interacting with the query endpoints.
- Base services for interacting with the event streaming API.
- An abstraction of DbgCensus.EventStream providing an asynchronous and decoupled event handling model.

Features

• Fluent query building API
• Full coverage of the Census query and event streaming interfaces.
• Fully asynchronous.
• Built around the Microsoft.Extensions framework.
• Compiled for .NET 5.0.

⚠️ DbgCensus is currently in an unstable state. This means that:

• The code has been 'tested' by my own workloads, but not thoroughly hand or unit tested.
• The API is liable to change, although it is beginning to reach maturity.
• Documentation is a bit lacking, although the code is fully XML documented.

Getting Started

Before you do anything, you should consider getting a custom Census Service ID. The process is free and it generally only takes a few hours to hear back about your registration, which you can do here.

Note that you can use the example service ID, however you will be rate-limited to 10 requests per minute, per client IP address.

You will also need to have a good understanding of how the Census API works. I highly recommend making your way through these excellent official/community docs:

• The official Census API documentation.
• Leonhard's Census API Primer.
• The community API issue tracker/info repository
• Leonhard's unofficial docs for PlanetSide 2 endpoints.
• #api-dev channel in the PlanetSide 2 Community Discord server for general API questions.

Examples

Check out the samples to get up and running quickly with DbgCensus. These demonstrate typical usage of the libraries within the Generic Host framework.

The EventStreamSample utilises DbgCensus' event handling framework. If you'd prefer to use another method of dispatching and handling events, you'll need to extend the BaseEventStreamClient instead, and register it yourself using the AddCensusEventStreamServices extension method.

Core Components

The Core library contains common types and extensions. Of these, it is likely you will find the Census objects useful (DbgCensus.Core.Objects). There are:

• Enumerations of the faction, world and zone IDs that Census uses.
• A ZoneId record that represents Census' special zone ID format - see here for more info. JSON converters are registered by default for this type, so you can use it anywhere that you would normally use an integer zone ID in your models.

There are also converters, extensions and naming policies for System.Text.Json that you may find useful should you decide to perform your own JSON deserialisation.

Interacting with Census Query Endpoints

Check out REST Sample as you read through this.

Start off by creating a new project. I would highly recommend using a template that implements the Generic Host, such as a Worker Service or an ASP.NET Core project.

Then, install the REST package:

# Visual Studio Package Manager
Install-Package DbgCensus.Rest
# dotnet console
dotnet add package DbgCensus.Rest

If your project integrates with the Microsoft.Extensions framework, you can easily register the required services to the container with the AddCensusRestServices extension method:

using DbgCensus.Rest.Extensions;

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureServices((configuration, services) =>
        {
            services.AddCensusRestServices();
        });

If you aren't using the Microsoft.Extensions framework, take a look at this file to see how the required services are setup.

Customising Query Options

You will need configure an instance of the CensusQueryOptions class to ensure that your service ID is utilised. I like to register my options from a configuration source (usually a section of appsettings.json) to retrieve any secrets that shouldn't be stored with the code, and then follow up with any additional configuration.

.ConfigureServices((hostContext, services) =>
    {
        services.Configure<CensusQueryOptions>(hostContext.Configuration.GetSection(nameof(CensusQueryOptions)));
        // AND/OR
        services.Configure<CensusQueryOptions>(o => o.DeserializationOptions = new JsonSerializerOptions(...));
    });

Performing Queries

Grab an IQueryService instance. This is a wrapper around the registered IQueryBuilderFactory and ICensusRestClient objects, which you can use individually if you need slightly more control over your queries.

IQueryBuilder query = _queryService.CreateQuery()
    .OnCollection("character")
    .Where("name.first_lower", SearchModifier.Equals, "falconeye36");

try
{
    Character? character = await _queryService.GetAsync<Character>(query, ct).ConfigureAwait(false);
    if (character is null)
    {
        _logger.LogInformation("That character does not exist.");
        return;
    }
}
catch (Exception ex)
{
    _logger.LogError(ex, "Failed to retrieve character.");
}