Commandor 1.0.0

Commandor.Example

This package provides an example implementation of the Commandor CQRS framework. It demonstrates how to use the framework to build a RESTful API with proper CQRS patterns.

Features

• Complete example of CQRS implementation
• RESTful API endpoints
• Proper error handling
• Input validation
• Swagger/OpenAPI documentation
• Dependency injection setup
• Example commands and queries
• Example handlers and validators

Getting Started

1. Install the package:

dotnet add package Commandor.Example

2. Add the required services in your Program.cs:

// Add CQRS services
builder.Services.AddCommandor();

// Register query handlers
builder.Services.AddScoped<IQueryHandler<GetProductsQuery, Result<IEnumerable<Product>>>, GetProductsQueryHandler>();
builder.Services.AddScoped<IQueryHandler<GetProductQuery, Result<Product>>, GetProductQueryHandler>();

// Register validators
builder.Services.AddScoped<IValidator<GetProductsQuery>, GetProductsQueryValidator>();
builder.Services.AddScoped<IValidator<GetProductQuery>, GetProductQueryValidator>();

// Register validation behavior
builder.Services.AddScoped(typeof(IPipelineBehavior<GetProductsQuery, Result<IEnumerable<Product>>>), typeof(ValidationBehavior<GetProductsQuery, Result<IEnumerable<Product>>>));
builder.Services.AddScoped(typeof(IPipelineBehavior<GetProductQuery, Result<Product>>), typeof(ValidationBehavior<GetProductQuery, Result<Product>>));

3. Define your endpoints:

app.MapGet("/products", async (IEnumerable<string>? ids, IDispatcher dispatcher) =>
{
    var query = new GetProductsQuery { Ids = ids };
    var result = await dispatcher.SendAsync<IEnumerable<Product>>(query);
    return result.IsSuccess 
        ? Results.Ok(result.Value) 
        : Results.BadRequest(new ErrorResponse(result.Error));
});

Example Usage

Commands

// Create a command
var command = new CreateProductCommand 
{ 
    Name = "Example Product",
    Price = 99.99m
};

// Send the command
var result = await dispatcher.SendAsync<string>(command);

Queries

// Create a query
var query = new GetProductQuery { Id = "123" };

// Send the query
var result = await dispatcher.SendAsync<Product>(query);

Error Handling

The example includes proper error handling with consistent error responses:

public sealed record ErrorResponse(string Error);

Validation

Input validation is handled using FluentValidation:

public sealed class GetProductQueryValidator : AbstractValidator<GetProductQuery>
{
    public GetProductQueryValidator()
    {
        RuleFor(x => x.Id)
            .NotEmpty()
            .WithMessage("Product ID is required");
    }
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.