Table of Contents

Namespace CSF.Screenplay.WebApis

Classes

Endpoint

A Web API endpoint which has no expected request payload and which is not expected to return a response body.

EndpointBase

Abstract base class for types which represent web API endpoints.

Endpoint<TResult>

A Web API endpoint which has no expected request payload and which is expected to return a response body that exposes a strongly-typed object.

HttpRequestMessageBuilder

An object which can create an HttpRequestMessage for use with an HTTP client.

HttpRequestMessageBuilder<TResponse>

An object which can create an HttpRequestMessage for use with an HTTP client, which is expected to expose a response of a particular type.

HttpResponseMessageAndResponseType<TResponse>

Wraps an HttpResponseMessage but also provides information about the expected response type from that message.

JsonEndpoint<TParameters>

Base type for a Web API endpoint which accepts a request payload in the form of a strongly typed object serialized to JSON string, but which is not expected to return a response body.

JsonEndpoint<TParameters, TResult>

Base type for a Web API endpoint which accepts a request payload in the form of a strongly typed object serialized to JSON string, and which is expected to return a response body that exposes a strongly-typed object.

MakeWebApiRequests

An ability class which allows Actors to make HTTP web API requests using HttpClient.

NameValueRecordCollection<TKey, TValue>

A simple name/value collection with an indexer, backed by a Dictionary<TKey, TValue>.

ParameterizedEndpoint<TParameters>

Base type for a Web API endpoint which has a strongly-typed request payload but which is not expected to return a response body.

ParameterizedEndpoint<TParameters, TResponse>

Base type for a Web API endpoint which has a strongly-typed request payload and which is expected to return a response body that exposes a strongly-typed object.

SendTheHttpRequest

An action which creates & sends an HTTP request using the specification within an HttpRequestMessageBuilder.

SendTheHttpRequestAndGetJsonResponse<TResponse>

An action which creates & sends an HTTP request, using the specification within an HttpRequestMessageBuilder<TResponse> and returns a strongly-typed result deserialized from a JSON HTTP response.

SendTheHttpRequestAndGetTheResponse<TResponse>

An action which creates & sends an HTTP request using the specification within an HttpRequestMessageBuilder<TResponse> and returns a result which preserves the intended response type.

WebApiBuilder

A builder for the performables SendTheHttpRequest and SendTheHttpRequestAndGetTheResponse<TResponse>.