VerticalApi 2024.12.23.171334

Introduction

VerticalApi is intended to be a simple implementation of Vertical slicing and Minimal Api at the same time.
By allowing simplistic folder structure and a minimal amount of boilerplate code it creates an easy way to setup individual endpoints and maintaining them over time.

Setup

Mapping endpoints

In the following example all endpoints relevant to public access will be mapped.
This is done by setting the property NamespaceRoot to endpoints/public.
The setting will map all found endpoints contained in the ApplicationNameSpace.endpoints.public

app.MapEndpoints(new EndpointOptions()
{
  NamespaceRoot = "endpoints/public",
  ApiBasePath = "api/public",
});

Endpoint Options

NameSpaceRoot:

Reflects the root of the namespace desired to be mapped.

Example: ApplicationNamespace.Area.Endpoints can be mapped with area/endpoints
Example: ApplicationNamespace.Endpoints.Public can be mapped with endpoints/public

ApiBasePath:

Sets the base path for the mapped endpoint.
Example: api/public will become https://domain.com/api/public/*
Example: endpoints/public will become https://domain.com/endpoints/public/*

RequireAuthorization:

If endpoints in the mapping should be authorized, set this to true.
It is necessary for app.UseAuthorization() to be called before mapping for authorization to be enabled.
Note: The [AllowAnonymous] attribute will override the authorization requirement on individual endpoints

AuthenticationScheme:

Set the desired authentication scheme that should apply to the given endpoints. Note: Requires the RequireAuthorization attribute to be enabled, as well as app.UseAuthentication()

CorsPolicyName:

Sets the name for the Cors policy to be used with the mapped endpoints.
Note: Requires app.UseCors() to be set.

Endpoint file

The endpoint file will consist of a class containing one or more methods that can be mapped as endpoints.
These methods must always be public and static in order for them to be mapped.
Everything else is considered private methods.

namespace SolutionName.Endpoints.Public.Articles;

[Endpoint]
public static class GetByIdEndpoint {
  
  public static async Task<Article> Get(
    [FromRoute] int Id,
    [FromServices] DataContext context,
    CancellationToken cancellationToken) 
  {
  
    var article = await context.Articles.FirstAsync(article => article.Id == Id, cancellationToken);
  
    return article;
  }
}

Folder structure

One of the intentions for VerticalApi is to simplify folder structures and assist in making it easier to create a simple edition of vertical slicing.
Below is an example of how a folder structure could be set up.

  SolutionName
    - Endpoints
      - Public
        - Articles
          - GetById
            | GetById.cs
            - Dtos
              | GetByIdResponse.cs
            - Tests
              | GetByIdTest.cs

The structure allows for segmentation of the endpoint logic from the DTOs, Mappers, Helpers and other logic that ties in closely to the endpoint.