Skip to content

Matching a request

Jump to bottom
Martijn Bodeman edited this page Dec 29, 2023 · 11 revisions

MockHttp provides a fluent API to make setting up request expectations and verifications easy.

Example

Create the handler and then start configuring a request:

var mockHttp = new MockHttpHandler();
mockHttp
    .When(matching => matching
        // Start chaining request expectations
        .Method(...)
        .RequestUri(...)
        // etc...
    )
    ...

Configure multiple requests on the same handler as needed.

Fluent API methods

Method Description 
.Method("POST")
.Method(HttpMethod.Put)
 Matches the request method. 
.RequestUri("http://localhost/exact/match?query=string")
.RequestUri("*/match*")
 Matches an url. Accepts wildcard *. 
.QueryString("key", "value")
.QueryString("?key=value1&other=value&key=value2")
.QueryString(new Dictionary<string, string>
{
    { "key", "value" }
}
.QueryString(new NameValueCollection
{
    { "key", "value" }
}
 Matches a query string by one or more key/value pairs. Note: the overload that accepts a full query string must be URI data escaped. 
.WithoutQueryString()
 Matches a request without query string. 
.Body("text content")
.Body("text content", Encoding.UTF8)
.Body(stream)
.Body(byteArray)
 Matches the request content body. 
.JsonBody(new { name = "John" }) // Defaults to STJ.
.JsonBody(
  new { name = "John" },
  new JsonSerializerOptions() // STJ
)
.JsonBody(
  new { name = "John" },
  new JsonSerializerSettings() // Newtonsoft
)
 Matches the request content body as JSON.
Requires 'skwas.MockHttp.Json' package 
.WithoutBody()
 Matches a request without content. 
.PartialBody("text content")
.PartialBody("text content", Encoding.UTF8)
.PartialBody(byteArray)
 Matches the content body partially. 
.ContentType("application/json; charset=utf-8")
.ContentType("text/plain", Encoding.ASCII)
 Matches the request content type. 
.Header("Authorization", "Bearer 123")
.Header("Content-Length", 123)
.Header("Last-Modified", DateTime.UtcNow)
.Header("Authorization")
.Headers("Accept: text/html")
.Headers(new Dictionary<string, string>
{
    { "Authorization", "Bearer 123" }
})
 Matches request headers by one or more key/value pairs. 
.FormData("key", "value")
.FormData("key=value1&other=value&key=value2")
.FormData(new Dictionary<string, string>
{
    { "key", "value" }
}
.FormData(new NameValueCollection
{
    { "key", "value" }
}
 Matches form url encoded or multipart encoded form data by one or more key/value pairs. Note: the overload that accepts a string must be URI data escaped. 
.Any(any => any
    .Method("GET")
    .Method("POST")
)
 Matches when at least one of the inner configured conditions is true. 
.Where(request => true|false)
 Matches the request using a custom predicate/expression. 
.Version("2.0")
.Version(new Version(1, 1))
 Matches the request by HTTP message version.

Negating a match

Sometimes you have to just assert that something is NOT in the request. In such case use the .Not Fluent operator:

var mockHttp = new MockHttpHandler();
mockHttp
    // Match all requests without Authorization header
    .When(m => m.Not.Header("Authorization"))
    .Respond(with => with.StatusCode(HttpStatusCode.Unauthorized));

Note: this is new in v2.4.x

MockHttp

Clone this wiki locally