netcore-boilerplate

Boilerplate of API in

.NET Core 3.1

| GitHub | Codecov | |:-------------:|:-------------:| | | |

Boilerplate is a piece of code that helps you to quickly kick-off a project or start writing your source code. It is kind of a template - instead of starting an empty project and adding the same snippets each time, you can use the boilerplate that already contains such code.

Source code contains

1. ~~[Autofac]~~(https://autofac.org/) (Removed in PR19)
2. Swagger + Swashbuckle
3. FeatureManagement (Feature Flags, Feature Toggles)
4. HealthChecks
5. EF Core
   • MySQL provider from Pomelo Foundation
   • MsSQL from Microsoft
6. Tests
   • Integration tests with InMemory database
     • FluentAssertions
     • xUnit
     • TestServer
   • Unit tests
     • AutoFixture
     • FluentAssertions
     • Moq
     • Moq.AutoMock
     • xUnit
   • Load tests
     • FluentAssertions
     • NBomber
     • xUnit
7. Code quality
   • EditorConfig (.editorconfig)
   • Analizers (Microsoft.CodeAnalysis.Analyzers, Microsoft.AspNetCore.Mvc.Api.Analyzers)
   • Rules
   • Code coverage
     • Coverlet
     • Codecov
8. Docker
   • Dockerfile
   • Docker-compose

     • mysql:8

       with DB initialization

     • mcr.microsoft.com/mssql/server:2017-latest

       with DB initialization

     • netcore-boilerplate:local

9. Serilog
   • Sink: Async
   • Enrich: CorrelationId
10. DbUp as a db migration tool
11. Continuous integration
    • ~~[Travis CI]~~(https://travis-ci.org/) (travisci.yml)
    • GitHub Actions (dotnetcore.yml)

Architecture

Api

HappyCode.NetCoreBoilerplate.Api

• Simple Startup class - Startup.cs
  • MvcCore
  • DbContext (with MySQL)
  • DbContext (with MsSQL)
  • Swagger and SwaggerUI (Swashbuckle)
  • HostedService and HttpClient
  • FeatureManagement
  • HealthChecks
  • MySQL
  • MsSQL
• Filters
  • Simple

    ApiKey

    Authorization filter - ApiKeyAuthorizationFilter.cs
  • Action filter to validate

    ModelState

    - ValidateModelStateFilter.cs
  • Global exception filter - HttpGlobalExceptionFilter.cs
• Configurations
  • Dependency registration place - ContainerConfigurator.cs

  • Serilog

    configuration place - SerilogConfigurator.cs

  • Swagger

    configuration place - SwaggerConfigurator.cs
• Simple exemplary API controllers - EmployeesController.cs, CarsController.cs
• Example of BackgroundService - PingWebsiteBackgroundService.cs

Core

HappyCode.NetCoreBoilerplate.Core

• Dto models
• DB models
• Registration module - GeneralRegisterModule.cs
• Exemplary MySQL repository - EmployeeRepository.cs
• Exemplary MsSQL service - CarService.cs
• AppSettings models
• Simple MySQL DbContext - EmployeesContext.cs
• Simple MsSQL DbContext - CarsContext.cs

DB Migrations

HappyCode.NetCoreBoilerplate.Db

• Console application as a simple db migration tool - Program.cs
• Sample migration scripts, both

  .sql

  and

  .cs

  - S001_AddCarTypesTable.sql, S002_ModifySomeRows.cs

Tests

Integration tests

HappyCode.NetCoreBoilerplate.Api.IntegrationTests

• Infrastructure
  • Fixture with TestServer - TestServerClientFixture.cs
  • TestStartup with InMemory databases - TestStartup.cs
  • Simple data feeders - EmployeeContextDataFeeder.cs, CarsContextDataFeeder.cs
• Exemplary tests - EmployeesTests.cs, CarsTests.cs

Unit tests

HappyCode.NetCoreBoilerplate.Api.UnitTests

• Exemplary tests - EmployeesControllerTests.cs
• Unit tests of

  ApiKeyAuthorizationFilter.cs

  - ApiKeyAuthorizationFilterTests.cs

HappyCode.NetCoreBoilerplate.Core.UnitTests

• Extension methods to mock

  DbSet

  faster - EnumerableExtensions.cs
• Exemplary tests - EmployeeRepositoryTests.cs, CarServiceTests.cs

Load tests

Keep in mind that entire environment has to be up and running.

HappyCode.NetCoreBoilerplate.Api.LoadTests

• Base class for controller - LoadTestsBase.cs
• Exemplary tests - EmployeesControllerTests.cs, CarsControllerTests.cs

How to adapt to your project

Generally it is totally up to you! But in case you do not have any plan, You can follow below simple steps:

1. Download/clone/fork repository :arrowheadingdown:
2. Remove components and/or classes that you do not need to :fire:
3. Rename files (e.g. sln, csproj, ruleset), folders, namespaces etc :memo:
4. Appreciate the work :star:

Build the solution

Just execute

dotnet build

HappyCode.NetCoreBoilerplate.sln

Start the application

Standalone

At first, you need to have up and running MySQL and MsSQL database servers on localhost with initialized database by mysql script and mssql script.

Then the application (API) can be started by

dotnet run

src/HappyCode.NetCoreBoilerplate.Api

Docker (recommended)

Just run

docker-compose up

Migrations

When the entire environment is up and running, you can additionally run a migration tool to add some new schema objects into MsSQL DB. To do that, go to

src/HappyCode.NetCoreBoilerplate.Db

dotnet run

Run unit tests

Run

dotnet test

HappyCode.NetCoreBoilerplate.sln

Migrate from ASP .NET Core 2.2 to 3.1

Need to migrate from

.NET Core 2.2

.NET Core 3.1

To Do

• any idea? Please create an issue.

Be like a star, give me a star! :star:

If:

• you like this repo/code,
• you learn something,
• you are using it in your project/application,

then please give me a

star

Buy me a coffee! :coffee: