BitzArt.Flux.Rest 0.3.2-Prerelease

Flux.REST

Installation

To use a REST client in your project, add the nuget package (The package is currently prerelease)

dotnet add package BitzArt.Flux.REST --prerelease

Usage

Configure Flux

services.AddFlux(flux =>
{
    flux.AddService("service1")     // Give your external service a specific name
    .UsingRest("https://test.com")  // External service's base url
        .AddEntity<YourEntity>()    // Adds an Entity of a specific type
        .WithEndpoint("entity");    // Entity endpoint : https://test.com/entity
});

Use IFluxContext in your app

1. Resolve IFluxContext from your DI container

serviceProvider.GetRequiredService<IFluxContext>();

2. Get your entity context

var entityContext = fluxContext.Entity<YourEntity>()

3. Use the IEntityContext to interact with this entity:

var entity = await entityContext.GetAsync(1); // Will make an http request to https://test.com/entity/1

var list = await entityContext.GetAllAsync(); // Will make an http request to https://test.com/entity

var page = await entityContext.GetPageAsync(0, 10); // Will make an http request to https://test.com/entity?offset=0&limit=10

Advanced scenarios

Entity endpoint configuration

WithEndpoint("your-entity-endpoint") // Sets the entity REST endpoint, e.g. https://test.com/your-entity-endpoint

WithIdEndpoint((key) => $"something/{key}") // Sets the entity ID endpoint, e.g. https://test.com/something/1

WithPageEndpoint("your-page-endpoint") // Sets the entity Page endpoint, e.g. https://test.com/your-page-endpoint

Custom variables

You can add custom variables to your endpoint configurations:

services.AddFlux(flux =>
{
    flux.AddService("service1")
    .UsingRest("https://test.com")
        .AddEntity<YourEntity>()
        .WithEndpoint("{a}/{b}");
});

Provide variable values when calling an appropriate method:

var a = "first";
var b = "second";
var entity = await entityContext.GetAsync(1, a, b); // Will make an http request to https://test.com/first/second/1

Custom Page endpoint with parent id example:

Flux configuration:

services.AddFlux(flux =>
{
    flux.AddService("service1")
    .UsingRest("https://test.com")
        .AddEntity<Book>()
        .WithPageEndpoint("authors/{authorId}/books");
});

Usage:

var books = fluxContext.Entity<Book>();

var authorId = 15;
var booksPage = await books.GetPage(0, 10, authorId); // https://test.com/authors/15/books?offset=0&limit=10