Endpoints

Endpoints are fundamental to this extension; they are .NET class instances which describe a piece of API functionality which may be consumed. The single most important (and obvious) piece of information stored in an endpoint object is the URL (route) which is used to communicate with the API function.

Endpoint classes

The WebAPIs Screenplay extension provides a number of classes by which to describe endpoints. Developers using this extension are encouraged to create 'libraries' of Endpoints within their own logic. Such a library might be as simple as a static class which contains public static get-only properties, each of which returns a named endpoint. Every endpoint class derives from a base class named EndpointBase.

The endpoint classes available are listed below. There is also an article indicating how to choose an appropriate combination of Endpoint and Request action.

• Endpoint
• Endpoint<TResponse>
• ParameterizedEndpoint<TParameters> - intended to be used as a base class
• ParameterizedEndpoint<TParameters,TResponse> - intended to be used as a base class
• JsonEndpoint<TParameters>
• JsonEndpoint<TParameters,TResponse>

Common to all endpoints

All endpoints describe:

• The URL pattern to reach the endpoint
• The HTTP method used with the endpoint
• A human-readable name for the endpoint
• An optional timeout for the endpoint