CommonApiTestLib 1.2.1

API Test Standard Library

This package helps set up API test standards for your project. It provides a structured approach to API testing, ensuring consistency and reliability across your project.

Features

1. Handle HTTP Request Methods using RestSharp
2. Auto-structure Endpoint API Headers, Authentication, and Base URL
3. Smart logging for easy debugging and tracking of API requests and responses
4. Good support for data-driven testing:
   • Helpers to generate data
   • Helpers to fetch data from the database
5. Support for multiple environments (e.g., development, staging, production)
6. Deserialization of responses to strongly typed objects
7. Async/Await modernization
8. Auto pick up different environment when running on CI/CD pipeline

Example Usage

Set up Endpoint

Inherit the class EndpointCommon by passing HTTP Method, Resource, and JSON Schema file:

public class AuthEndpoint : EndpointCommon
{
    private const Method method = Method.Post;
    private const string resource = "/auth";
    // private const string schema = "GetAuth.json";
    protected override string Schema { get; set; } = "GetAuth.json";

    public AuthEndpoint() : base(method, resource)
    {
    }

    public void SetRequest(object? requestBody)
    {
        // add headers, auth token, query parameters

        // add json
        if (requestBody != null) AddJsonBody(requestBody);
    }
}

Make API Call in a Safer Way

Smart logging and error handling make it easy to debug: endpoint.SetRequest(jsonBody);

Standard Output

[09:57:15 INF] adding header: Content-Type
[09:57:15 INF]  - adding json: "{ username = admin, password = password123 }" to Request
[09:57:15 INF]  - setting up RestClient to https://restful-booker.herokuapp.com
[09:57:16 INF]  - response is OK {"token":"1060da51499abd5"}```
[09:57:16 INF] Validating response schema: format, required fields, type etc

Deserialize Response to Strongly Typed Object

//Also uses Async/Await for better performance:
var responseBody = await endpoint.ExecuteAsync<Token>();
Assert.That(responseBody.Data.token, Is.EqualTo("8d39ee85d901265"));

Auto Pick Up Different Environment Configuration

Set up in test.runsettings file:

<EnvironmentVariables>
    
    <EnvironmentName>qa</EnvironmentName>
</EnvironmentVariables>
And in `appsettings.{EnvironmentName}.json`:
{
  "booking": {
    "BaseUrl": "https://restful-booker.herokuapp.com"
  },
  "todo": {
    "BaseUrl": "https://jsonplaceholder.typicode.com"
  },
  "ConnectionStrings": {
    "dsn": "qa-db-connection-url"
  }
}```