taorodrigueswork / rest-api

This is a template for building REST APIs using .NET 7 and Entity Framework Core 7. It is a monolith using multilayer architecture and uses some common libraries and configurations very used in the .Net community.

REST API TEMPLATE .NET CORE 7 / ENTITY FRAMEWORK CORE 7

This is a template for building REST APIs using .NET 7 and Entity Framework Core 7. It is a monolith using multilayer architecture and uses some common libraries and configurations very used in the .Net community.

To get started, you need to:

• clone this repository
• install SQL Server on your machine
• replace ConnectionString to this configuration in your appsettings.json:

"ConnectionStrings": {
  "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=ApiTemplate;Trusted_Connection=True;"
}

• run the application using Visual Studio 2022 or the .NET CLI

Technologies

This project uses the following technologies:

• .NET 7
• C#
• SQL Server for developing and production, and SQLite in Memory for Integration Testing.
• Entity Framework Core 7
• Serilog
• Seq or Elastic Search
• Automapper
• nUnit, AutoFixture
• Swagger
• Global Error Middleware
• Repository Pattern
• Azure Key Vault
• Sonar Cloud
• Coverlet
• Validation Filter Attribute to validate DTOs
• API Versioning and improved swagger documentation to support multiple versions
• Azure Container Registry

Project Design

This project has classes representing one-to-many and many-to-many relationships, based on the database diagram below. A schedule has a list of days (one-to-many), which also can have a list of person, and each person can belong to multiple days (many-to-many).

Project Structure

• API: This folder contains the source code for the web API.
  • Controllers: This folder contains the controllers that handle incoming requests.
  • Program.c s: This file is responsible for configuring and running the web host. After .NET6 we don't have to use Startup.cs anymore. And the code in the Program file is more concise and simple. TODO: Code Coverage is not ignoring this file when running GitHub Actions using dot net cli and SonarCloud.
  • CustomMiddlewares: Implements the IMiddleware interface and is responsible for global error handling. It intercepts exceptions thrown by the application and throw the corret exception.
  • ValidationFilterAttribute.cs: Validates DTO required properties.
• Business: This project uses a generic Interface in all classes, in order to make it simple to make dependency injection. We only need to register one time in the Program.cs file and it is going to inject all business classes into the system commented. All classes receive an AutoMapper and a Log via dependency injection.
  • IBusiness: This folder contains the interfaces for the business logic components.
• Entities: This folder contains the entity models.
  • DTO: This folder contains the data transfer objects (DTOs) used for request and response payloads.
  • Entity: This folder contains the database entities. There is a many-to-many relationship example with an explicit class to handle it. There is also a BaseEntity class with a generic validate method for the entities.
  • MapperProfile: This file contains the AutoMapper mappings profile between DTOs and entity models.
• Persistence: This folder contains the data access layer components, using Entity Framework Core ORM.
  • Context: It has an ApiContext that inherits from DbContext, which is a class provided by Entity Framework Core that represents a session with the database and allows you to query and save instances of your entity classes.
  • Migrations: Contain all migration files defining the changes to the model that should be applied to the database. NOTE: We are using SQL Server for production and Development and SQLite to run Integration Tests. In order to run the same migrations for different providers, we need to edit the migration and create a conditional to verify if the provider is SQL Server or SQLite. The difference between them is the AutoIncrement syntax for Primary Keys.
  • Repository: This folder contains the repository classes that handle database operations.
  • IRepository: This folder contains the interfaces for the repository classes.
• Tests: This folder contains the business tests using NUnit, Mock and AutoFixture.

Components

Dockerfile, Azure Container Registry

In a project that utilizes .NET 7, there is no need to create a Dockerfile for containerization. Instead, developers can leverage the convenience of a NuGet package called Microsoft.NET.Build.Containers. To build and push the latest build to the staging environment using Azure Container Registry, all that is required is to execute the build-staging.yml file. (Azure Container Registry is a cloud-based container registry provided by Microsoft's Azure platform. It serves as a centralized repository for storing and managing Docker container images).

Logging

The logging component uses the built-in Serilog library. The logging level can be configured through the appsettings.json file. The logs are sent to Seq, but the configuration to log in an ElasticSearch sink is already in the Program.cs file.

Database Connectivity

The database connectivity is handled by Entity Framework Core. The database connection string can be configured through the appsettings.json file. All the migrations are going to run automatically when the application runs.

DTOs

DTOs are used to prevent exposing entity models directly to the API consumers. It allows for maintaining a clear separation between the application and the database. AutoMapper library is used to map data between DTOs and entity models.

Azure Key Vault

Azure Key Vault is a cloud service that can be used to store secrets and configuration data for .NET or ASP.NET Core applications. Azure Key Vault securely stores secret values and allows access to those values without any explicit code change to both applications hosted in Azure and users based on their Azure credentials.