Class RestRequestBuilder

Namespace

ProtoTest.Rest

Assembly

ProtoTest.Rest.dll

public sealed class RestRequestBuilder

Inheritance

object

RestRequestBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

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

Methods

Auth(IProtoHttpAuthenticator)

public RestRequestBuilder Auth(IProtoHttpAuthenticator authenticator)

Parameters

authenticator IProtoHttpAuthenticator

Returns

RestRequestBuilder

Auth<TAuth>(params object[])

public RestRequestBuilder Auth<TAuth>(params object[] constructorArgs) where TAuth : class, IProtoHttpAuthenticator

Parameters

constructorArgs object[]

Returns

RestRequestBuilder

Type Parameters

TAuth

Body(Func<HttpContent>)

Supplies fresh request content for each send, allowing a builder to be reused safely.

public RestRequestBuilder Body(Func<HttpContent> contentFactory)

Parameters

contentFactory Func<HttpContent>

Returns

RestRequestBuilder

Body(object, JsonSerializerOptions?)

public RestRequestBuilder Body(object payload, JsonSerializerOptions? options = null)

Parameters

payload object

options JsonSerializerOptions

Returns

RestRequestBuilder

Body(ReadOnlyMemory<byte>, string)

public RestRequestBuilder Body(ReadOnlyMemory<byte> content, string mediaType = "application/octet-stream")

Parameters

content ReadOnlyMemory<byte>

mediaType string

Returns

RestRequestBuilder

Body(string, string)

public RestRequestBuilder Body(string rawContent, string mediaType = "text/plain")

Parameters

rawContent string

mediaType string

Returns

RestRequestBuilder

DeleteAsync(string, object?, CancellationToken)

public Task<RestResponse> DeleteAsync(string routeTemplate, object? routeAndQueryParams = null, CancellationToken ct = default)

Parameters

routeTemplate string

routeAndQueryParams object

ct CancellationToken

Returns

Task<RestResponse>

GetAsync(string, object?, CancellationToken)

public Task<RestResponse> GetAsync(string routeTemplate, object? routeAndQueryParams = null, CancellationToken ct = default)

Parameters

routeTemplate string

routeAndQueryParams object

ct CancellationToken

Returns

Task<RestResponse>

HeadAsync(string, object?, CancellationToken)

public Task<RestResponse> HeadAsync(string routeTemplate, object? routeAndQueryParams = null, CancellationToken ct = default)

Parameters

routeTemplate string

routeAndQueryParams object

ct CancellationToken

Returns

Task<RestResponse>

Header(string, string)

public RestRequestBuilder Header(string name, string value)

Parameters

name string

value string

Returns

RestRequestBuilder

OptionsAsync(string, object?, CancellationToken)

public Task<RestResponse> OptionsAsync(string routeTemplate, object? routeAndQueryParams = null, CancellationToken ct = default)

Parameters

routeTemplate string

routeAndQueryParams object

ct CancellationToken

Returns

Task<RestResponse>

PatchAsync(string, object?, CancellationToken)

public Task<RestResponse> PatchAsync(string routeTemplate, object? routeAndQueryParams = null, CancellationToken ct = default)

Parameters

routeTemplate string

routeAndQueryParams object

ct CancellationToken

Returns

Task<RestResponse>

PostAsync(string, object?, CancellationToken)

public Task<RestResponse> PostAsync(string routeTemplate, object? routeAndQueryParams = null, CancellationToken ct = default)

Parameters

routeTemplate string

routeAndQueryParams object

ct CancellationToken

Returns

Task<RestResponse>

PutAsync(string, object?, CancellationToken)

public Task<RestResponse> PutAsync(string routeTemplate, object? routeAndQueryParams = null, CancellationToken ct = default)

Parameters

routeTemplate string

routeAndQueryParams object

ct CancellationToken

Returns

Task<RestResponse>

SendAsync(HttpMethod, string, object?, CancellationToken)

public Task<RestResponse> SendAsync(HttpMethod method, string routeTemplate, object? routeAndQueryParams = null, CancellationToken ct = default)

Parameters

method HttpMethod

routeTemplate string

routeAndQueryParams object

ct CancellationToken

Returns

Task<RestResponse>

WithoutAuth()

Disables inherited or class-level authentication for this request builder.

public RestRequestBuilder WithoutAuth()

Returns

RestRequestBuilder