RobertEru.ApiHelper.Client 1.4.0

API Helper Client Package Documentation

Installation

To use this package, you first need to install it on your project. You can do this by using the package manager console in Visual Studio or by running the following command in your terminal:

dotnet add package RobertEru.ApiHelper.Client

Usage

After installing the package, add the extension service builder.service.ApiHelperClient() in your Program.cs or Startup.cs file. If it throws an error, enter using ApiHelper.Extensions at the top of your Program.cs or Startup.cs file.

Inject ICallApiProcessor inside the class constructor where you want to use it.

You will have access to two methods: formatRequest() and processRequest().

formatRequest() takes the following parameters:

• objectBody: The request body in object format.
• url: The URL of the API endpoint.
• httpMethod: The HTTP method to use (e.g. GET, POST, PUT, DELETE, etc.).
• headers: The headers to include in the request.

Please note that you do not need to pass "application/json" in the headers, as the package already takes care of that.

processRequest() sends the formatted request to the API endpoint and returns the response. The response properties are .Message, .IsError, .Code, and .Content.

Example

using ApiHelper.Extensions;
public class MyApiClient
{
private readonly ICallApiProcessor _callApi;


public MyApiClient(ICallApiProcessor callApi)
{
    _callApi = callApi;
}

public async Task<MyApiResponse> CallApi(MyApiRequest request)
{
    var requestPayload = _callApi.formatRequest(
        objectBody: request.Body,
        url: request.Url,
        httpMethod: request.Method,
        headers: request.Headers
    );

    var response = await _callApi.processRequest(requestPayload);

    return new MyApiResponse
    {
        Message = response.Message,
        IsError = response.IsError,
        Code = response.Code,
        Content = response.Content
    };
}
}

Summary

This package provides an easy-to-use API client for .NET applications. By following the steps outlined above, you can quickly install and use the package to make API requests and receive responses.