Class RestShouldAssertions

Namespace

ProtoTest.Rest

Assembly

ProtoTest.Rest.dll

The positive assertions of a REST response, reached through Should. Shape is positive-only - a negated shape match has no meaning - so it lives here and not on the shared facade ShouldNot returns. MatchShape(object, JsonSerializerOptions?) returns the response, so assertions chain.

public sealed class RestShouldAssertions : RestAssertions

Inheritance

object

ProtoHttpAssertions<RestResponse>

RestAssertions

RestShouldAssertions

Inherited Members

RestAssertions.HaveContentType(string)

RestAssertions.HaveHeader(string)

RestAssertions.HaveHeader(string, string)

RestAssertions.HaveCookie(string)

RestAssertions.HaveCookie(string, string)

RestAssertions.HaveRedirectLocation(string)

ProtoHttpAssertions<RestResponse>.HaveHttpStatus(HttpStatusCode)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, bool, JsonSerializerOptions?)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Methods

MatchShape(object, bool, JsonSerializerOptions?)

Matches the response body against the expected shape exactly: a field present in the body that the shape does not mention is a mismatch naming the field, so the response cannot grow a field the test never asserted. A value constraint mentions its whole subtree. Returns the response.

public RestResponse MatchShape(object expectedShape, bool exact, JsonSerializerOptions? options = null)

Parameters

expectedShape object

exact bool

options JsonSerializerOptions

Returns

RestResponse

MatchShape(object, JsonSerializerOptions?)

Matches the response body against the expected shape and records the assertion on the test context. Every mismatch is reported at once, and the failure message starts with the request identifier. Returns the response.

public RestResponse MatchShape(object expectedShape, JsonSerializerOptions? options = null)

Parameters

expectedShape object

options JsonSerializerOptions

Returns

RestResponse