TypedRest for .NET 1.3.5
build type-safe fluent-style REST API clients
TypedRest.Endpoints.EntryEndpoint Class Reference

Represent the top-level URI of an API. Derive from this class and add your own set of child-IEndpoints as properties. More...

Inheritance diagram for TypedRest.Endpoints.EntryEndpoint:
TypedRest.Endpoints.EndpointBase TypedRest.Endpoints.IEndpoint

Public Member Functions

 EntryEndpoint (HttpClient httpClient, Uri? uri=null, MediaTypeFormatter? serializer=null, IErrorHandler? errorHandler=null, ILinkExtractor? linkExtractor=null)
 Creates a new entry endpoint. More...
 
 EntryEndpoint (Uri uri, NetworkCredential? credentials=null, MediaTypeFormatter? serializer=null, IErrorHandler? errorHandler=null, ILinkExtractor? linkExtractor=null)
 Creates a new entry endpoint. More...
 
async Task ReadMetaAsync (CancellationToken cancellationToken=default)
 Fetches meta data such as links from the server. More...
 
- Public Member Functions inherited from TypedRest.Endpoints.EndpointBase
void SetDefaultLink (string rel, string? href)
 Registers one or more default links for a specific relation type. These links are used when no links with this relation type are provided by the server. This should only be called during initial setup of the endpoint. More...
 
void SetDefaultLinkTemplate (string rel, string? href)
 Registers a default link template for a specific relation type. This template is used when no template with this relation type is provided by the server. This should only be called during initial setup of the endpoint. More...
 
IReadOnlyList<(Uri uri, string? title)> GetLinks (string rel)
 Resolves all links with a specific relation type. Uses cached data from last response. More...
 
Uri Link (string rel)
 Resolves a single link with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
UriTemplate GetLinkTemplate (string rel)
 Retrieves a link template with a specific relation type. Prefer IEndpoint.LinkTemplate(string,object) when possible. More...
 
Uri LinkTemplate (string rel, IDictionary< string, object > variables)
 Resolves a link template with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
Uri LinkTemplate (string rel, object variables)
 Resolves a link template with a specific relation type. More...
 
override string ToString ()
 

Additional Inherited Members

- Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
 EndpointBase (Uri uri, HttpClient httpClient, MediaTypeFormatter serializer, IErrorHandler errorHandler, ILinkExtractor linkExtractor)
 Creates a new endpoint with an absolute URI. More...
 
 EndpointBase (IEndpoint referrer, Uri relativeUri)
 Creates a new endpoint with a relative URI. More...
 
 EndpointBase (IEndpoint referrer, string relativeUri)
 Creates a new endpoint with a relative URI. More...
 
virtual async Task< HttpResponseMessage > HandleAsync (Func< Task< HttpResponseMessage > > request, [CallerMemberName] string caller="unknown")
 Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors. More...
 
Activity? StartActivity ([CallerMemberName] string caller="unknown")
 Starts a new Activity if there is any listener registered (e.g. OpenTelemetry), returns null otherwise. More...
 
virtual void HandleCapabilities (HttpResponseMessage response)
 Handles allowed HTTP methods and other capabilities reported by the server. More...
 
bool? IsMethodAllowed (HttpMethod method)
 Shows whether the server has indicated that a specific HTTP method is currently allowed. More...
 
- Static Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
static Func< IEndpoint, Uri, TEndpoint > GetConstructor< TEndpoint > ()
 Returns a constructor for TEndpoint as a function with a referrer an a relative URI as input. More...
 
- Properties inherited from TypedRest.Endpoints.EndpointBase
Uri Uri [get]
 
HttpClient HttpClient [get]
 
MediaTypeFormatter Serializer [get]
 
IErrorHandler ErrorHandler [get]
 
ILinkExtractor LinkExtractor [get]
 
- Properties inherited from TypedRest.Endpoints.IEndpoint
Uri Uri [get]
 The HTTP URI of the remote resource.
 
HttpClient HttpClient [get]
 The HTTP client used to communicate with the remote resource.
 
MediaTypeFormatter Serializer [get]
 Controls the serialization of entities sent to and received from the server.
 
IErrorHandler ErrorHandler [get]
 Handles errors in responses.
 
ILinkExtractor LinkExtractor [get]
 Extracts links from responses.
 

Detailed Description

Represent the top-level URI of an API. Derive from this class and add your own set of child-IEndpoints as properties.

Constructor & Destructor Documentation

◆ EntryEndpoint() [1/2]

TypedRest.Endpoints.EntryEndpoint.EntryEndpoint ( HttpClient  httpClient,
Uri?  uri = null,
MediaTypeFormatter?  serializer = null,
IErrorHandler errorHandler = null,
ILinkExtractor linkExtractor = null 
)
inline

Creates a new entry endpoint.

Parameters
httpClientThe HTTP client used to communicate with the REST API.
uriThe base URI of the REST API. Missing trailing slash will be appended automatically. HttpClient.BaseAddress is used if this is unset.
serializerControls the serialization of entities sent to and received from the server. Defaults to DefaultJsonSerializer if unset.
errorHandlerHandles errors in HTTP responses. Defaults to DefaultErrorHandler if unset.
linkExtractorDetects links in HTTP responses. Combines HeaderLinkExtractor and HalLinkExtractor if unset.

◆ EntryEndpoint() [2/2]

TypedRest.Endpoints.EntryEndpoint.EntryEndpoint ( Uri  uri,
NetworkCredential?  credentials = null,
MediaTypeFormatter?  serializer = null,
IErrorHandler errorHandler = null,
ILinkExtractor linkExtractor = null 
)
inline

Creates a new entry endpoint.

Parameters
uriThe base URI of the REST API.
credentialsOptional HTTP Basic authentication credentials used to authenticate against the REST API.
serializerControls the serialization of entities sent to and received from the server. Defaults to a JSON serializer if unset.
errorHandlerHandles errors in HTTP responses. Leave unset for default implementation.
linkExtractorDetects links in HTTP responses. Leave unset for default implementation.

Member Function Documentation

◆ ReadMetaAsync()

async Task TypedRest.Endpoints.EntryEndpoint.ReadMetaAsync ( CancellationToken  cancellationToken = default)

Fetches meta data such as links from the server.

Exceptions
AuthenticationExceptionHttpStatusCode.Unauthorized
UnauthorizedAccessExceptionHttpStatusCode.Forbidden
KeyNotFoundExceptionHttpStatusCode.NotFound or HttpStatusCode.Gone
HttpRequestExceptionOther non-success status code.

The documentation for this class was generated from the following file: