Class ProtoHttpResponseOptions

Namespace

ProtoTest.Http

Assembly

ProtoTest.Http.dll

Controls how HTTP response bodies are buffered, shared by the REST and GraphQL integrations. Each protocol registers an instance created with its own configuration section.

public class ProtoHttpResponseOptions : IProtoConfigurableOptions

Inheritance

object

ProtoHttpResponseOptions

Implements

IProtoConfigurableOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ProtoConfigurableOptionsExtensions.BindFromConfiguration(IProtoConfigurableOptions, IConfiguration)

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

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

Constructors

ProtoHttpResponseOptions()

Creates options for a protocol that does not name a section, defaulting to ProtoTest:Http:Responses.

public ProtoHttpResponseOptions()

ProtoHttpResponseOptions(string)

Creates options bound to a known configuration section, e.g. ProtoTest:Rest:Responses.

public ProtoHttpResponseOptions(string configurationSectionName)

Parameters

configurationSectionName string

Properties

ConfigurationSectionName

The configuration section this instance binds from, e.g. "ProtoTest:Rest:Responses".

public string ConfigurationSectionName { get; }

Property Value

string

MaxDiagnosticBodyLength

Maximum length of the response body embedded in a failure message, such as the body in a RestStatusAssertionException. Defaults to 64 KiB and binds from the same section, so a protocol's diagnostic cap can be configured alongside its buffering cap.

public int MaxDiagnosticBodyLength { get; set; }

Property Value

int

MaxResponseBodyBytes

Maximum response body size buffered by a convenience API. Defaults to 10 MiB.

public int MaxResponseBodyBytes { get; set; }

Property Value

int

Methods

Validate()

Validates the resolved options once, after code callbacks and configuration have been applied. A bad value is a configuration error and must throw here rather than fail the first test that happens to use it. The default does nothing.

public void Validate()