ASP.NET Onion Architecture Solution Template

Template Description

This is a template package with two solution templates:

ASP.NET Web API application,
gRPC application.

Both of these solutions are built according to the Onion Architecture.

You can create a new solution based on one of these templates by installing the associated NuGet package and using it from Visual Studio 2022 and later or directly with DotNet CLI commands.

Each template contains:

Domain, Application, Persistence, Infrastructure, and API projects,
MS SQL and MongoDB persistence layer implementations which the user can choose during solution creation,
Optional Entity Framework migrations project,
Unit tests and Component tests template projects,

The template of your choice contains either:

API project with REST minimal APIs and, optionally, standard controllers
API project with gRPC service

Getting Started

Building nuget package from source code

To build the NuGet package from the source code follow the next steps:

install nuget.exe
run nuget pack command from the root of the repository

nuget pack aspnet-onion-template.nuspec -NoDefaultExcludes

Installing the templates

To install this package on your system from a NuGet package stored at nuget.org run the following command with the latest package version

dotnet new --install AHutak.OnionArchitecture.AspNet::<latest version>

To install this package on your system from a local nupkg file run the following command with the latest package version

dotnet new install <PATH_TO_NUPKG_FILE>/AHutak.OnionArchitecture.AspNet.<latest version>.nupkg

For more information see Installing a template package.

You should see the message shown below which indicates a successful installation

After that you have several options, to use it either from Visual Studio 2022 or from the command line.

From Visual Studio 2022:

From command-line:

dotnet new oa-sln-aspnet-grpc -n Your-Project-Name

dotnet new oa-sln-aspnet-webapi -n Your-Project-Name

To view other available command-line solution parameters please run

dotnet new oa-sln-aspnet-grpc --help

dotnet new oa-sln-aspnet-webapi --help

At the moment these templates support two persistence layer implementations:

MS SQL with EF Core
MongoDB.

You can select one of them during solution creation.

Launching the solution

The next step to launch the newly created solution is updating the appsettings json files in the API project.
You will need to provide the database connection information.
Depending on the selected Persistence layer implementation appsettings json files will contain one of the configuration sections:

for MongoDB

  "MongoDbSettings": {
    "ConnectionString": "",
    "DatabaseName": ""
  }

for MS SQL

  "ConnectionStrings": {
    "MyDbConnectionString": ""
  }

If MS SQL persistence implementation was selected during solution creation you have to run migrations on your database. This step can be done with the following commands run from the root directory of your solution (assuming you have installed the "dotnet ef" tools)

  dotnet ef database update -p src/your-solution-name.Persistence.MsSql.Migrations/ -s src/your-solution-name.Persistence.MsSql.Migrations/ --connection 'your-connection-string'

For more information on Entity Framework Core tools see Entity Framework Core tools reference

After that, you can launch the API project from Visual Studio or the command line.

Support

If you are having problems, please let us know by raising a new issue.

License

This project is licensed with the MIT license.

agutak/aspnet-onion-template