FastProjects.Endpoints 1.0.8

To configure the repository template:

1. Update workflows. If you use CodeQL, rename the codeql.yml.example to codeql.yml.
2. Create a solution file and add projects to .src/ or .tests/ folders.
3. Fill the information in .nuspec file about nuget package.
4. Update README.md file (also, remove this section).

🚀 FastProjects.Endpoints

🚨 ALERT: Project Under Development This project is not yet production-ready and is still under active development. Currently, it's being used primarily for personal development needs. However, contributions are more than welcome! If you'd like to collaborate, feel free to submit issues or pull requests. Your input can help shape the future of FastProjects!

📚 Overview

Collection of endpoint base classes that wraps FastEndpoints classes and integrated with MediatR and Result patterns.

Complete documentation of the FastEndpoints can be found here.

🛠 Roadmap

• ✅ FastEndpoint - Base class for endpoints that uses MediatR and Result patterns with response body
• ✅ FastEndpointWithoutResponse - Base class for endpoints that uses MediatR and Result patterns without response body

🚀 Installation

You can download the NuGet package using the following command to install:

dotnet add package FastProjects.Endpoints

Usage

Example of dummy create project use-case implementation:

// Application layer below implemented via MediatR
public sealed record CreateProjectCommand(string Name) : ICommand;
    
public sealed class CreateProjectCommandHandler : SharedKernel.ICommandHandler<CreateProjectCommand>
{
    public async Task<Result> Handle(CreateProjectCommand request, CancellationToken cancellationToken)
    {
        await Task.Delay(1, cancellationToken);
        return Result.Success();
    }
}

// Presentation layer below implemented via FastEndpoints

public sealed class CreateProjectRequest
{
    public const string Route = "/projects";
    
    public static string BuildRoute() => Route;
    
    public string Name { get; set; }
}

public sealed class CreateProjectValidator : Validator<CreateProjectRequest>
{
    public CreateProjectValidator()
    {
        RuleFor(x => x.Name).NotEmpty();
    }
}

public sealed class CreateProjectEndpoint(IMediator mediator)
    : FastEndpointWithoutResponse<CreateProjectRequest,
        CreateProjectCommand,
        Result>(mediator)
{
    public override void Configure()
    {
        Post(CreateProjectRequest.Route);
        Version(0);
        AllowAnonymous();
        
        Summary(s =>
        {
            s.ExampleRequest = new CreateProjectRequest { Name = $"Test Project" };
        });
    }
    
    protected override CreateProjectCommand CreateMediatorCommand(CreateProjectRequest request) =>
        new(request.Name);
}

More example can be found in sample TestApp project.

🤝 Contributing

This project is still under development, but contributions are welcome! Whether you’re opening issues, submitting pull requests, or suggesting new features, we appreciate your involvement. For more details, please check the contribution guide. Let’s build something amazing together! 🎉

📄 License

FastProjects is licensed under the MIT License. See the LICENSE file for full details.