GenXCleanArchTemplate.WebAPI 1.0.7

GenX Clean Architecture Template

Creating a new project

To create a new project using the template, run the following command:

dotnet new genx-cleanarch -n NewProjectName

Project Structure

For each entity in your database model, create the following structure:

|- Domain
   |- Entities
      -- <entity>.cs
|- Infrastructure
   |- Config
      -- <entity>Config.cs
   |- Repositories
      -- <entity>Repository.cs
   |- Interfaces
      -- I<entity>Repository.cs
|- Application
   |- Services
      -- <entity>Service.cs
   |- Interfaces
      -- I<entity>Service.cs
|- WebAPI
   |- Controllers
      -- <entity>Controller.cs

Configuring each entity in the project

1. Update the AppDbContext.cs file:

Location: Infrastructure/Data/AppDbContext.cs

Add the following configuration for each entity:

public DbSet<entity> <entity> { get; set; }

2. Configure in the Program.cs file:

Location: WebAPI/Program.cs

Add the following services for each entity:

builder.Services.AddScoped<I<entity>Repository, <entity>Repository>();
builder.Services.AddScoped<I<entity>Service, <entity>Service>();

Creating a MySQL Database

Follow the steps below to set up the MySQL database:

1. Access the MySQL terminal:

mysql -u root -p

2. Create the database and user:

CREATE DATABASE `GenXCleanArchTemplate-db` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'GenXCleanArchTemplate-user'@'localhost' IDENTIFIED BY 'GenXCleanArchTemplate-password';
GRANT ALL PRIVILEGES ON `GenXCleanArchTemplate-db`.* TO 'GenXCleanArchTemplate-user'@'localhost';
FLUSH PRIVILEGES;
exit;

Creating Entity Framework (EF) Migrations Scripts

1. Install the EF Core CLI tool (if not installed yet):

dotnet tool install --global dotnet-ef

2. Create the initial migration:

dotnet ef migrations add initial-migration --project GenXCleanArchTemplate.Infrastructure --startup-project GenXCleanArchTemplate.WebAPI

3. Update the database:

dotnet ef database update --project GenXCleanArchTemplate.Infrastructure --startup-project GenXCleanArchTemplate.WebAPI

Running the WebAPI

You can run the WebAPI in two ways:

1. From the terminal:

dotnet run --project GenXCleanArchTemplate.WebAPI

2. In debug mode:

If using Visual Studio Code, press F5 to start in Debug mode.

The GenX Clean Architecture template is now configured and ready to use. 🚀

PT-BR

Criando um novo projeto

Para criar um novo projeto utilizando o template, execute o seguinte comando:

dotnet new genx-cleanarch -n NewProjectName

Estrutura do Projeto

Para cada entidade do seu modelo de banco de dados, crie a seguinte estrutura:

|- Domain
   |- Entities
      -- <entity>.cs
|- Infrastructure
   |- Config
      -- <entity>Config.cs
   |- Repositories
      -- <entity>Repository.cs
   |- Interfaces
      -- I<entity>Repository.cs
|- Application
   |- Services
      -- <entity>Service.cs
   |- Interfaces
      -- I<entity>Service.cs
|- WebAPI
   |- Controllers
      -- <entity>Controller.cs

Configuração para cada entidade no projeto

1. Atualize o arquivo AppDbContext.cs:

Local: Infrastructure/Data/AppDbContext.cs

Adicione a seguinte configuração para cada entidade:

public DbSet<entity> <entity> { get; set; }

2. Configure no arquivo Program.cs:

Local: WebAPI/Program.cs

Adicione os seguintes serviços para cada entidade:

builder.Services.AddScoped<I<entity>Repository, <entity>Repository>();
builder.Services.AddScoped<I<entity>Service, <entity>Service>();

Criando um banco de dados MySQL

Siga os passos abaixo para configurar o banco de dados MySQL:

1. Acesse o terminal do MySQL:

mysql -u root -p

2. Crie o banco de dados e o usuário:

CREATE DATABASE `GenXCleanArchTemplate-db` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'GenXCleanArchTemplate-user'@'localhost' IDENTIFIED BY 'GenXCleanArchTemplate-password';
GRANT ALL PRIVILEGES ON `GenXCleanArchTemplate-db`.* TO 'GenXCleanArchTemplate-user'@'localhost';
FLUSH PRIVILEGES;
exit;

Criando scripts de migração do Entity Framework (EF)

1. Instale a ferramenta CLI do EF Core (caso ainda não tenha instalado):

dotnet tool install --global dotnet-ef

2. Gere a migração inicial:

dotnet ef migrations add initial-migration --project GenXCleanArchTemplate.Infrastructure --startup-project GenXCleanArchTemplate.WebAPI

3. Atualize o banco de dados:

dotnet ef database update --project GenXCleanArchTemplate.Infrastructure --startup-project GenXCleanArchTemplate.WebAPI

Executando a WebAPI

Você pode executar a WebAPI de duas formas:

1. Pelo terminal:

dotnet run --project GenXCleanArchTemplate.WebAPI

2. No modo de depuração:

Se estiver usando o Visual Studio Code, pressione F5 para iniciar no modo Debug.

Pronto! O template GenX Clean Architecture está configurado e pronto para uso. 🚀