ProtoTest.Rest 1.0.1

ProtoTest.Rest

A per-test HTTP client with route and query expansion, the shared [Auth<T>] pipeline, JSON shape assertions, capture and endpoint coverage.

dotnet add package ProtoTest.Rest

Quick start

builder.AddApplication("Api", app => app.AddRest(rest => rest
    .AddClient("Orders")));   // joins the application's BaseUrl with Endpoints:Orders

[Application("Api", "Rest:Orders")]
[Auth<BearerTokenAuthenticator>("token")]
public sealed class OrderTests
{
    [ProtoTest]
    public async Task GetOrder()
    {
        using var response = await Proto.Context.Rest()
            .GetAsync("/orders/{id}", new { id = 42 });

        response.Should.HaveHttpStatus(HttpStatusCode.OK)
            .ShouldMatchShape(new
            {
                id = 42,
                status = JsonValue.NotNull()
            });
    }
}

What it adds

• Clients — Proto.Context.Rest(name?) resolves a named HttpClient; AddClient accepts an explicit base URL, an endpoint name or a per-test Func<ProtoExecutionContext, Uri> resolver, and AddClientFrom reuses another integration's transport.
• Requests — Header, Body (object, raw, bytes or a content factory) and the verb helpers; {route} tokens and leftover properties expand into the route and query string.
• Assertions — response.Should.HaveHttpStatus(...), ShouldNot.HaveHttpStatus(...) and ShouldMatchShape(...); failures carry RestStatusAssertionException or JsonShapeMismatchException.
• Authentication — the shared [Auth<T>] pipeline plus per-request Auth(...)/WithoutAuth(), with built-in bearer, basic and API-key authenticators.
• Capture and coverage — CaptureAttachments() records redacted request/response bodies; RestCoverageCollector reports endpoints from http.response observations.
• Tracing — http.request operations with request/response sections, http.response/http.failure observations and assert.http.status/assert.json.shape checks.

Configuration

Under ProtoTest:Rest:Responses and ProtoTest:Rest:Attachments; code callbacks (ConfigureResponses, CaptureAttachments) run first and configuration is bound over them.

Shape assertions are positive-only; response bodies are always buffered in full and there is no retry policy.

Learn more

• REST guide
• DeliveryJourney.cs