ApiHelpers 2026.2.6.1

ApiHelpers

Multi-target library (.NET Standard 2.0 and .NET 8) for simplifying API interactions, including REST and JSON-RPC support in future. The core class, RestClientHelper, wraps RestSharp to simplify sending HTTP requests and handling responses in a modern, async-friendly way.

Integration

ApiHelper depends on and uses:

• CommonHelpers - Shared utilities, logging interfaces (ITestLogger), reporting, and common infrastructure

Features

• Async HTTP Methods: Supports async GET, POST, PUT, PATCH, and DELETE requests.

• Header and Body Support: Easily add custom headers and JSON bodies.

• Centralized Error Handling: Exceptions are wrapped with context for easier debugging.

• Extensible: Designed for use in .NET Standard 2.0 and .NET 8+ projects.

• RestSharp Integration: Built on the proven RestSharp library for reliable HTTP communication.

Prerequisites

• .NET Standard 2.0, .NET 8, or compatible • RestSharp • CommonHelpers - Shared utilities and logging interfaces

Installation

Add the library to your project: dotnet add package ApiHelper

Usage Example

using ApiHelpers.Rest; using CommonHelpers.Logging; using Xunit;

public class ApiLoginTest {

private readonly ITestLogger _logger; private readonly RestClientHelper _apiClient;

public ApiLoginTest(ITestLogger logger) { _logger = logger; _apiClient = new RestClientHelper(); }

[Fact] public async Task Login_ShouldReturnToken_WithValidCredentials() { // Arrange var loginUrl = "https://api.example.com/auth/login"; var requestBody = @"{ ""username"": ""testuser"", ""password"": ""testpass"" }";

_logger.Info("Sending login request...");

// Act
var response = await _apiClient.SendPostAsync(loginUrl, requestBody);

// Assert
Assert.True(response.IsSuccessful, $"Login failed: {response.ErrorMessage}");
Assert.Contains("token", response.Content);

_logger.Info("Login successful - token received");

} }

Project Structure

ApiHelpers/ ├── Rest/ │ ├── RestClientHelper.cs # REST API client with async HTTP methods └── README.md

Dependencies

This library depends on:

• CommonHelpers - Provides:

  • ITestLogger - Logging interface for API test logging
  • Shared utilities and infrastructure
  • Common helper methods used across the automation library suite

• RestSharp - Provides:

  • HTTP client functionality
  • Request/response handling
  • Modern async/await support