README.md

Queo.Commons.Web

Description

Queo.Commons.Web can be used working with an web app or web api.

How to use it

How to use ModelBinding

• include Nuget-Package (queo.commons.web.modelBinding)

   <PackageReference Include="Queo.Commons.Web.ModelBinding" Version="1.0.1" />

• If you want to use the ModelBinding, you have to add the following to your program.cs or startup.cs.

   builder.Services.AddJsonModelConverter();
   builder.Services.AddEntityBinder(0);

• In your controller you can use the following code to bind the model.

   [HttpGet("{id:guid}")]
   public IActionResult GetByIdWithModelBinding([FromServices, ModelBinder(Name = "Id")] EntityImplementation entityImplementation)
   {
   	if (entityImplementation != null)
   	{
   		return Ok(new EntityImplementationResponseModel(entityImplementation));
   	}
   	else
   	{
   		return NotFound();
   	}
   }

How to use ExceptionHandling

• include Nuget-Package (queo.commons.web.exceptionHandling)

   <PackageReference Include="Queo.Commons.Web.ExceptionHandling" Version="1.0.1" />

• Add the following code to your Programm.cs or Startup.cs

   builder.Services.UseExtendedProblemDetails();

How to use Security

• include Nuget-Package (queo.commons.web.security)

   	<PackageReference Include="Queo.Commons.Web.Security" Version="1.0.2" />

• Implement Classes for the the following interfaces:

  • IPermissionCalculator (here RoleToPermissionCalculator is used as an example)
  • ISecurityContext (here SecurityContext is used as an example)
  • ISecurityContextFactory (here SecurityContextFactory is used as an example)

• Add the following code to your Programm.cs or Startup.cs

   builder.Services.AddMethodAuthorize<AuthorizeService>();
   builder.Services.AddActionDecorator();
   builder.Services.AddSecurityContextServices<SecurityContext, SecurityContextFactory>();
   builder.Services.AddScoped<IPermissionCalculator, RoleToPermissionCalculator>();

• Add the following code to your Controller to enrich the response with the available permissions of the user

   [ActionDescription("delete_entityImplementation", "read_entityImplementation")]

  The available permissions in your Code needs to have the following structure: someWork_anotherWord!