HTTP Response Assertion

Bard natively supports out of the box the following HTTP responses

• HTTP 200 OK

• HTTP 201 Created

• HTTP 204 No Content

• HTTP 403 Forbidden

• HTTP 404 Not Found

If you need to Assert another HTTP code was returned then you can specify the HTTP code as well.

Bard allows you to assert that the correct headers are present in your API Response.

[Fact]
public void Should_included_content_type_header_with_correct_value()
{
   When.Get(URL);

   Then
       .Response
       .Headers
       .ShouldInclude("Content-Type", "application/json; charset=utf-8");
           
}

The response can be checked to ensure the correct error message or error code is returned by the API.

When your API returns an HTTP 400 Bard give you the ability to interrogate the API response in more detail.

This is the test assertion part of your test.

Bard provides a fluent API for working with your API responses. You can Assert that the response is as expected.

Bard provides the ability to assert that the API responses are returned within a specified timeframe. This can be asserted at a test level or globally for an entire Scenario.

Individual API Call Assertion

The test below show an individual assertion for a specific end point.

[Fact]
public void The_slow_running_endpoint_should_return_within_two_seconds()
{
    When
        .Get("api/slow-running-endpoint");
   
    Then
        .Response
        .Time
        .LessThan(2000); // Time in milliseconds.
    
}

Global Configuration

The scenario configuration below demonstrates how to set a global benchmark for all API calls so that they do not exceed 2000 milliseconds.

var scenario = ScenarioConfiguration
    .Configure(options =>
    {
        options.MaxApiResponseTime = 2000;
        // Other configuration goes here..
    });