Dangl.Data.Shared
This solution builds both Dangl.Data.Shared and Dangl.Data.Shared.AspNetCore packages.
The aim of this solution is to consolidate simple, reused code such as ApiError or RepositoryResult<T>.
Link to docs:
ModelStateValidationFilter
The ModelStateValidationFilter is a simple wrapper that returns a BadRequestObjectResult with an ApiError body when the passed ModelState
of an action is invalid. This allows to keep controlls free of basic model state validation logic.
To use the filter, it must be configured in the AddMvc() call in ConfigureServices:
services.AddMvc(options =>
{
options.Filters.Add(typeof(ModelStateValidationFilter));
})
RequiredFormFileValidationFilter
The RequiredFormFileValidationFilter is a simple wrapper that returns a BadRequestObjectResult with an ApiError body when the invoked
Controller action as paramaters of type IFormFile that are annotated with [Required] but have no value bound.
For example, the following action makes use of the filter:
[HttpPost("RequiredFormFile")]
public IActionResult RequiredFormFile([Required]IFormFile formFile)
{
return Ok();
}
To use the filter, it must be configured in the AddMvc() call in ConfigureServices:
services.AddMvc(options =>
{
options.Filters.Add(typeof(RequiredFormFileValidationFilter));
})
BiggerThanZeroAttribute
The BiggerThanZeroAttribute is a ValidationAttribute that can be applied to int properties to ensure their values are greater than zero.
JsonOptionsExtensions
The JsonOptionsExtensions class configures default Json options for the Newtonsoft Json serializer.
It ignores null values, uses the StringEnumConverter and ignores default values for Guid, DateTime
and DateTimeOffset.
IClaimBasedAuthorizationRequirement
The namespace Dangl.Data.Shared.AspNetCore.Authorization contains utilities that help in building authorization policies that
check for existing claims on authenticated users. By default, claim values that are either true or represent a valid-until time in
the future (like 2018-08-08T09:02:15.5732531Z) are considered valid and will lead to the requirement handler succeeding.
To use it, there is an interface for the requirements:
public interface IClaimBasedAuthorizationRequirement : IAuthorizationRequirement
{
IReadOnlyList<string> ClaimNames { get; }
}
Now, a class can be defined that implements this interface and be added as requirement in a policy:
o.AddPolicy(AvaCloudConstants.CONVERSION_POLICY_NAME, policy => policy
.AddRequirements(new ConversionRequirement(requiredUserClaim, requiredClientClaim)));
And the IAuthorizationHandler must be configured in the services:
services.AddTransient<IAuthorizationHandler, ClaimBasedAuthorizationRequirementHandler<ConversionRequirement>>();
HttpHeadRequestMiddleware
This middleware transforms incoming Http HEAD requests internally to GET requests so that they can hit their intended target action.
The body will be set to Stream.Null, so that only the response headers are being sent back to the client.
This should be called before the AddMvc() call, like this:
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
app.UseHttpHeadToGetTransform();
app.UseMvc();
}