Dotnet-9-CQRS-WebApi

Dotnet new template for Dotnet 9 CQRS WebApi with the following features:

• Aspire
  • OpenTelemetry
  • PostgreSQL database created on startup
  • Runs migrations on startup using FluentMigrator
  • Has Scalar UI Doc links in the Dashboard
  • Seq Dashboard
• FastEndpoints
  • REPR pattern endpoints
  • Commands and Queries
  • Security (etc.)
• Pseudo vertical slice architecture
• Dapper repositories (Npgsql/Postgres)
• Integration Tests
  • WebApplicationFactory pre-configured
  • Verify for testing HTTP responses
  • Fake JWT Tokens for testing
• Unit test projects

REMINDER: Update the author name in the Directory.Build.props files.

How to use

1. Clone the repository
2. Navigate to the root directory of the project
3. Run dotnet new install . to install the template
4. Make/navigate to the project directory you want to create
5. Run dotnet new cqrs with the following parameter options
   • --name - The name of the project:
   • --IncludeExample - Includes an example ToDos project
6. cd ./src/Api and run dotnet user-jwts create --claim "nameid={guid}".
   • Helpful tool: I used the dotnet-guid tool to generate a GUID in the terminal for the nameid.
   • Feel free to add more claims or add a name to the JWT as well. All requests require the nameid to be present though.
   • This creates a user-secrets id and updates the appsettings.Development.json file with data related to your JWT information.
   • Use the output token to make requests in the provided Scalar GUI or your favorite API testing client.
7. Open the solution in your preferred IDE
8. Ensure you are using the Aspire https run configuration
   • Alternatively, you can run dotnet run --project infra/AppHost from the solution root directory.

If you include the example project, everything should work as expected. You will see the Aspire dashboard open on your browser with the following:

• Postgres
• PgAdmin
• Migrator (runs migrations on startup and shut down)
• Api (main project)

CQRS Onion Architecture Overview

The basic idea of CQRS in simple terms is a loosely coupled architecture. The layers do the following:

• Domain: processes business logic and ensures objects are valid
• Application: maps/translates external requests (API requests) into domain models and calls the infrastructure layer's persistence services to persist data.
• Infrastructure: manages external dependencies, such as database connections, requests to other services (e.g. API requests to other services, such as an email API), etc.
• Presentation: interacts with inbound requests to the service. In this case, a Dotnet 8 Minimal API.

In this template, I have also included a Migrator project, which is responsible for creating and updating the database schema, and 2 Aspire related projects.