Nabs.Launchpad.Core.Apis 10.0.269

Nabs.Launchpad.Core.Apis

Nabs.Launchpad.Core.Apis gives you granular endpoint abstractions for consistent ASP.NET Core API endpoints.

Installation

dotnet add package Nabs.Launchpad.Core.Apis

The Problem

// 1) Controllers accumulate many actions over time
public class ProductsController : ControllerBase
{
    [HttpGet("{id:guid}")] public IActionResult Get(Guid id) => Ok();
    [HttpPost] public IActionResult Create(ProductRequest request) => Ok();
    [HttpPut("{id:guid}")] public IActionResult Update(Guid id, ProductRequest request) => Ok();
}

// 2) Endpoint intent is harder to isolate by file
// 3) Growth increases merge conflicts and maintenance overhead

Features

• Single-file endpoint abstraction through INabsEndpoint
• Declarative endpoint base class through NabsEndpointBase
• Typed request/response endpoint variants for common API patterns
• Constructor injection support for discovered endpoint classes
• Built-in request validation hooks with automatic ValidationProblem responses
• Automatic endpoint registration through MapNabsEndpoints(...)
• Deterministic endpoint discovery for predictable startup behavior
• Optional shared controller base through NabsControllerBase

Usage

public sealed class GetProductEndpoint : NabsEndpointBase
{
    public GetProductEndpoint()
        : base(new NabsEndpointOptions("/api/products/{id:guid}", HttpMethod.Get)
        {
            EndpointName = "GetProduct",
            Tags = ["Products"],
            Summary = "Get a product by id."
        })
    {
    }

    protected override Task<IResult> HandleAsync(HttpContext httpContext, CancellationToken cancellationToken)
    {
        var id = httpContext.GetRouteValue("id");
        return Task.FromResult<IResult>(Results.Ok(new { id }));
    }
}

public sealed class SecureProductEndpoint : NabsEndpointBase
{
    private readonly IProductService _productService = productService;

    public SecureProductEndpoint(IProductService productService)
        : base(new NabsEndpointOptions("/api/secure-products/{id:guid}", HttpMethod.Get)
        {
            RequireAuthorization = true,
            ExcludeFromDescription = false
        })
    {
        _productService = productService;
    }

    protected override Task<IResult> HandleAsync(HttpContext httpContext, CancellationToken cancellationToken)
    {
        var id = httpContext.GetRouteValue("id");
        return Task.FromResult<IResult>(Results.Ok(_productService.GetById(id)));
    }
}

// Program.cs
app.MapNabsEndpoints<Program>();

You can still implement INabsEndpoint directly for advanced scenarios.

Typed endpoint variants are available through NabsEndpointBase<TRequest, TResponse> with NabsNone as a marker for no request or no response payload:

public sealed class CreateOrderEndpoint : NabsEndpointBase<CreateOrderRequest, CreateOrderResponse>
{
    public CreateOrderEndpoint()
        : base(new NabsEndpointOptions("/api/orders", HttpMethod.Post)
        {
            EndpointName = "CreateOrder"
        })
    {
    }

    protected override Task<CreateOrderResponse> HandleAsync(CreateOrderRequest request, CancellationToken cancellationToken)
    {
        return Task.FromResult(new CreateOrderResponse(Guid.NewGuid()));
    }
}

public sealed class ProcessOrderEndpoint : NabsEndpointBase<ProcessOrderRequest, NabsNone>
{
    public ProcessOrderEndpoint()
        : base("/api/orders/process", HttpMethod.Post)
    {
    }

    protected override Task<NabsNone> HandleAsync(ProcessOrderRequest request, CancellationToken cancellationToken)
    {
        return Task.FromResult(default(NabsNone));
    }
}

public sealed class ValidatedOrderEndpoint : NabsEndpointBase<CreateOrderRequest, CreateOrderResponse>
{
    public ValidatedOrderEndpoint()
        : base("/api/orders/validated", HttpMethod.Post)
    {
    }

    protected override Task<IDictionary<string, string[]>?> ValidateRequestAsync(CreateOrderRequest request, CancellationToken cancellationToken)
    {
        if (!string.IsNullOrWhiteSpace(request.CustomerName))
        {
            return Task.FromResult<IDictionary<string, string[]>?>(null);
        }

        IDictionary<string, string[]> errors = new Dictionary<string, string[]>
        {
            ["customerName"] = ["Customer name is required."]
        };

        return Task.FromResult<IDictionary<string, string[]>?>(errors);
    }

    protected override Task<CreateOrderResponse> HandleAsync(CreateOrderRequest request, CancellationToken cancellationToken)
    {
        return Task.FromResult(new CreateOrderResponse(Guid.NewGuid()));
    }
}

public sealed class GetServerInfoEndpoint : NabsEndpointBase<NabsNone, ServerInfoResponse>
{
    public GetServerInfoEndpoint()
        : base("/api/server-info", HttpMethod.Get)
    {
    }

    protected override Task<ServerInfoResponse> HandleAsync(NabsNone request, CancellationToken cancellationToken)
    {
        return Task.FromResult(new ServerInfoResponse("v1"));
    }
}

Controller-based APIs remain supported:

[ApiController]
[Route("api/[controller]")]
public sealed class ProductsController : NabsControllerBase
{
    [HttpGet("{id:guid}")]
    public IActionResult Get(Guid id) => Ok(new { id });
}

Configuration

No package-specific configuration is required.

NabsEndpointOptions supports one or more HttpMethod values and validates them against a supported set: GET, POST, PUT, DELETE, PATCH, QUERY, HEAD, OPTIONS, TRACE, and CONNECT. When multiple methods are configured, only GET, QUERY, HEAD, and OPTIONS combinations are allowed.

Project Structure

• INabsEndpoint.cs - contract for one endpoint per class/file
• NabsEndpointBase.cs - declarative base class with override-driven configuration
• NabsEndpointBaseOfT.cs - typed base for request/response endpoints (use NabsNone for missing request or response payloads)
• NabsNone.cs - marker type representing no request or no response payload
• NabsEndpointRouteBuilderExtensions.cs - endpoint discovery and mapping extensions
• NabsControllerBase.cs - reusable base class for controller-based APIs

License

Copyright (c) Net Advantage Business Solutions.