StubHttp class¶

Summary¶

View source

A declarative test HttpMessageHandler for Refit clients, written as a route table: each entry pairs a RouteMatcher (built with Route) with a StubResponse (built with Reply). Populate it with a collection initializer whose templates mirror the routes declared on the Refit interface.

classDiagram
class StubHttp
class HttpMessageHandler
HttpMessageHandler <|-- StubHttp
class IEnumerable~RouteMatcher~ {
    <>
}
IEnumerable~RouteMatcher~ <|.. StubHttp
class IEnumerable {
    <>
}
IEnumerable <|.. StubHttp

Inherits from: HttpMessageHandler

Implements: IEnumerable, IEnumerable

Remarks¶

var http = new StubHttp
 {
 { Route.Get("/users/{id}"), Reply.With(new User("octocat")) },
 { Route.Post("/users"), Reply.Status(HttpStatusCode.Created) },
 };
 var api = http.CreateClient<IGitHubApi>(baseUrl);

Non-reusable routes (the common case) are one-shot: each satisfies exactly one request and is then consumed, and VerifyAllCalled asserts every one was hit. Set Reusable for a background stub that may match any number of requests. An unmatched request throws rather than returning a canned 404, and every request is recorded in Requests for inspection — including typed inspection of the sent body via LastRequestBodyAsync.

Constructors¶

Properties¶

Methods¶