Kemenkeu.Client.Core 0.1.0

NuGet Package Documentation for Kemenkeu.Client.Core

Overview

Kemenkeu.Client.Core is a .NET library designed to provide core functionalities for Kemenkeu services. This package simplifies development by offering reusable components and services.

Installation

To install the NuGet package, use the following command in the Package Manager Console:

Install-Package Kemenkeu.Client.Core

Or, using the .NET CLI:

dotnet add package Kemenkeu.Client.Core

Configuration

Add the following configuration to your appsettings.json and adjust according the system config:

1. With User Token

{
  "ExternalService": {
    "BaseUrl": "https://thegatewayservice.com"
  }
}

2. With Application Token

{
  "Auth": {
    "AuthorityUrl": "https://authorizationserver.net",
  },
  "ExternalService": {
    "BaseUrl": "https://gatewayserver.net",
    "Auth": {
      "ClientId": "client_id",
      "ClientSecret": "client_secret",
      "GrantType": "grant_type",
      "Scope": "scope"
    },
  }
}

or

{
  "ExternalService": {
    "BaseUrl": "https://gatewayserver.net",
    "AuthorityUrl": "https://authorizationserver.net",
    "Auth": {
      "ClientId": "client_id",
      "ClientSecret": "client_secret",
      "GrantType": "grant_type",
      "Scope": "scope"
    },
  }
}

Usage

1. With User Token

a. Setup in Startup.cs

In .NET 5 or Older, use Startup.cs to configure services.

Register Kemenkeu.Client.Core in the ConfigureServices method:

public class Startup
{
    public IConfiguration Configuration { get; }

    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddKemenkeuClient(config =>
        {
            config.WithUserToken(Configuration);
        });
            
        // Other services...
    }
}

b. Setup in Program.cs

In .NET 6 or later, configure services directly in Program.cs.

Configure services and add caching:

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddKemenkeuClient(config =>
{
    config.WithUserToken(builder.Configuration);
});

var app = builder.Build();

// Configure others.

app.Run();

2. With Application Token

a. Setup in Startup.cs

In .NET 5 or Older, use Startup.cs to configure services.

Register Kemenkeu.Client.Core in the ConfigureServices method:

public class Startup
{
    public IConfiguration Configuration { get; }

    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddKemenkeuClient(config =>
        {
            config.WithApplicationToken(Configuration);
        });
            
        // Other services...
    }
}

b. Setup in Program.cs

In .NET 6 or later, configure services directly in Program.cs.

Configure services and add caching:

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddKemenkeuClient(config =>
{
    config.WithApplicationToken(builder.Configuration);
});

var app = builder.Build();

// Configure others.

app.Run();

3. Setup in your Project Controller or Service

1. Add a reference to the Kemenkeu.Client.Core package in your project.
2. Import the necessary namespaces in your code:

using Kemenkeu.Client.Core;

3. Utilize the provided classes and methods as needed.

Sample usage IKemenkeuClient directly in your controller:

[ApiController]
[Route("[controller]")]
public class SampleController : ControllerBase
{
    private readonly IKemenkeuClient _kemenkeuClient;

    public SampleController(IKemenkeuClient kemenkeuClient)
    {
        _kemenkeuClient = kemenkeuClient;
    }

    [HttpGet]
    public async Task<ActionResult<SomeModel>> GetAsync()
    {
        string path = "path/to/service/controller/endpoint";

        // Get the HttpClient
        HttpClient client = _kemenkeuClient.GetClient();

        // Execute with auxilary function GetFromApiDataAsync provided by this package
        // It will will automatically unwrap the data from the json "data" field
        SomeModel result = await client.GetFromApiDataAsync<SomeModel>(path);

        // or anothers ordinary HttpClient methods such as GetFromJsonAsync, GetAsync
        // SomeModel result = await client.GetFromJson<SomeModel>(path);

        return result;
    }
}

Sample usage IKemenkeuClient in service:

public class SampleService
{
    private readonly IKemenkeuClient _kemenkeuClient;

    public SampleService(IKemenkeuClient kemenkeuClient)
    {
        _kemenkeuClient = kemenkeuClient;
    }

    public async Task<SomeModel> GetDataAsync()
    {
        string path = "path/to/service/controller/endpoint";

        // Get the HttpClient
        HttpClient client = _kemenkeuClient.GetClient();

        // Execute with auxilary function GetFromApiDataAsync provided by this package
        // It will will automatically unwrap the data from the json "data" field
        SomeModel result = await client.GetFromApiDataAsync<SomeModel>(path);

        // or anothers ordinary HttpClient methods such as GetFromJsonAsync, GetAsync
        // SomeModel result = await client.GetFromJson<SomeModel>(path);

        return result;
    }
}

Requirements

• .NET Version: This package compatible with .NET Core 2.1 (via .NET Standard 2.0), .NET Core 3.1 and later.