Provides a set of interfaces and classes that the Collector Common RestClient and Collector Common RestApi will understand.
First, we need to introduce the concept of 'resource identifier'. The resource identifier represents the resource location. The resource identifier might contain properties, identifying a resource e.g. by its id.
The class must implement IResourceIdentifier.
public class MyEndpointResourceIdentifier : IResourceIdentifier
{
public string Id { get; set; }
public string Uri => $"api/my-endpoint/{Id}";
}Sub class the RequestBase class and provide your resource identifier, the HTTP Method and the ConfigurationKey.
All requests to the same api will normally have the same configuration key (more on this can be found in Common.RestClient).
Example PUT request (no response object):
public class MyEndpointPUTRequest : RequestBase<MyEndpointResourceIdentifier>
{
public MyEndpointPUTRequest(MyEndpointResourceIdentifier resourceIdentifier)
: base(resourceIdentifier)
{
}
public string SomeProperty { get; set; }
/// <returns>The HTTP method for this request</returns>
public override HttpMethod GetHttpMethod() => HttpMethod.PUT;
/// <returns>The identification for this api</returns>
public override string GetConfigurationKey() => "MyApiContractKey";
}Sub class the abstract RequestBase<TIdentifier, TResponse> and provide your response type.
public class MyEndpointGETRequest : RequestBase<MyEndpointResourceIdentifier, MyEndpointGetResponse>
{
public MyEndpointGETRequest(MyEndpointResourceIdentifier resourceIdentifier)
: base(resourceIdentifier)
{
}
/// <returns>The HTTP method for this request</returns>
public override HttpMethod GetHttpMethod() => HttpMethod.GET;
/// <returns>The identification for this api</returns>
public override string GetConfigurationKey() => "MyApiContractKey";
}Where the response class is just a POCO
public class MyEndpointGetResponse
{
public string SomeProperty { get; set; }
}By default, no validation is enabled, but it is possible to have validation of the properties for a given Request.
In order to provide a validator for the Request, override the ValidateRequest() method:
public class MyEndpointPUTRequest : RequestBase<MyEndpointResourceIdentifier>
{
public MyEndpointPUTRequest(MyEndpointResourceIdentifier resourceIdentifier)
: base(resourceIdentifier)
{
}
public string SomeProperty { get; set; }
[StringLength(10, ErrorMessage = "THE_SHORT_STRING_LENGTH_EXCEEDED")]
public string AShortString { get; set; }
/// <returns>The HTTP method for this request</returns>
public override HttpMethod GetHttpMethod() => HttpMethod.PUT;
/// <returns>The identification for this api</returns>
public override string GetConfigurationKey() => "MyApiContractKey";
/// <summary>
/// Validates the request
/// </summary>
/// <returns>Validation error messages, if any</returns>
protected override IEnumerable<string> ValidateRequest()
{
///... Your own validation result, with error messages, if any.
}
}