netcore-blueprint 0.0.2 → 0.0.3

package/BlueprintTemplate/Host.API/Extensions/ApplicationBuilderExtensions.cs

@@ -0,0 +1,26 @@
+namespace Host.API.Extensions
+{
+    public static class ApplicationBuilderExtensions
+    {
+        public static WebApplication UseApiMiddleware(this WebApplication app)
+        {
+            if (app.Environment.IsDevelopment())
+            {
+                app.UseSwagger();
+                app.UseSwaggerUI(c =>
+                {
+                    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Host API v1");
+                    c.RoutePrefix = "swagger";
+                });
+            }
+
+            app.UseCors("AllowAll");
+            app.UseHttpsRedirection();
+            app.UseAuthentication();
+            app.UseAuthorization();
+            app.MapControllers();
+
+            return app;
+        }
+    }
+}

package/BlueprintTemplate/Host.API/Extensions/DatabaseExtensions.cs

@@ -0,0 +1,37 @@
+using Microsoft.EntityFrameworkCore;
+using Shared.Infrastructure;
+
+namespace Host.API.Extensions
+{
+    public static class DatabaseExtensions
+    {
+        public static IServiceCollection AddMySqlDatabase(
+            this IServiceCollection services,
+            IConfiguration configuration)
+        {
+            string? mySQLConnectionString =
+                configuration.GetConnectionString("MySQL");
+
+            if (!string.IsNullOrEmpty(mySQLConnectionString))
+            {
+                services.AddDbContext<MyDbContext>(options =>
+                    options.UseMySql(
+                        mySQLConnectionString,
+                        ServerVersion.AutoDetect(mySQLConnectionString)));
+            }
+
+            return services;
+        }
+
+        public static void ApplyDatabaseMigrations(this WebApplication app)
+        {
+            if (!app.Environment.IsDevelopment())
+                return;
+
+            using var scope = app.Services.CreateScope();
+            var dbContext = scope.ServiceProvider.GetRequiredService<MyDbContext>();
+            dbContext.Database.Migrate();
+        }
+    }
+
+}

package/BlueprintTemplate/Host.API/Extensions/ServiceCollectionExtensions.cs

@@ -0,0 +1,54 @@
+using ItemModule.API.Controllers.Public;
+using ItemModule.Infrastructure;
+using Shared.Infrastructure;
+using UserModule.API.Controllers.Admin;
+using UserModule.Infrastructure;
+
+namespace Host.API.Extensions
+{
+    public static class ServiceCollectionExtensions
+    {
+        public static IServiceCollection AddApiCore(
+            this IServiceCollection services,
+            IConfiguration configuration)
+        {
+            services.AddControllers()
+                .AddApplicationPart(typeof(UserController).Assembly)
+                .AddApplicationPart(typeof(ItemController).Assembly);
+
+            services.AddEndpointsApiExplorer();
+            services.AddSwaggerGen();
+
+            services.AddCors(options =>
+            {
+                options.AddPolicy("AllowAll", policy =>
+                {
+                    policy.AllowAnyOrigin()
+                          .AllowAnyHeader()
+                          .AllowAnyMethod()
+                          .WithExposedHeaders("X-WP-Total");
+                });
+            });
+
+            return services;
+        }
+
+        public static IServiceCollection AddUserModule(this IServiceCollection services)
+        {
+            UserDependencyInjection.AddUserModuleInfra(services);
+            return services;
+        }
+
+        public static IServiceCollection AddItemModule(this IServiceCollection services)
+        {
+            ItemDependencyInjection.AddItemModuleInfra(services);
+            return services;
+        }
+
+        public static IServiceCollection AddSharedModule(this IServiceCollection services)
+        {
+            SharedDependencyInjection.AddSharedInfrastructure(services);
+            return services;
+        }
+    }
+}

package/BlueprintTemplate/Host.API/Extensions/ThirdPartyExtensions.cs

@@ -0,0 +1,30 @@
+using Asp.Versioning;
+using ItemModule.API.Mappers;
+using UserModule.API.Mappers;
+
+namespace Host.API.Extensions
+{
+    public static class ThirdPartyExtensions
+    {
+        public static IServiceCollection AddThirdParty(this IServiceCollection services)
+        {
+            services.AddAutoMapper(
+                cfg => { },
+                typeof(DtoItemMappingProfile).Assembly,
+                typeof(DtoUserMappingProfile).Assembly
+            );
+
+            services.AddApiVersioning(opt =>
+            {
+                opt.DefaultApiVersion = new ApiVersion(1, 0);
+                opt.AssumeDefaultVersionWhenUnspecified = true;
+                opt.ReportApiVersions = true;
+                opt.ApiVersionReader =
+                    ApiVersionReader.Combine(new UrlSegmentApiVersionReader());
+            });
+
+            return services;
+        }
+    }
+
+}

package/BlueprintTemplate/Host.API/Host.API.csproj

@@ -0,0 +1,29 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.2" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="10.1.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\ItemModule.API\ItemModule.API.csproj" />
+    <ProjectReference Include="..\ItemModule.Core\ItemModule.Core.csproj" />
+    <ProjectReference Include="..\ItemModule.Infrastructure\ItemModule.Infrastructure.csproj" />
+    <ProjectReference Include="..\Shared.Core\Shared.Core.csproj" />
+    <ProjectReference Include="..\Shared.Infrastructure\Shared.Infrastructure.csproj" />
+    <ProjectReference Include="..\User.API\UserModule.API.csproj" />
+    <ProjectReference Include="..\User.Core\UserModule.Core.csproj" />
+    <ProjectReference Include="..\User.Infrastructure\UserModule.Infrastructure.csproj" />
+  </ItemGroup>
+
+</Project>

package/BlueprintTemplate/Host.API/Host.API.csproj.user

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <ActiveDebugProfile>https</ActiveDebugProfile>
+  </PropertyGroup>
+</Project>

package/BlueprintTemplate/Host.API/Host.API.http

@@ -0,0 +1,6 @@
+@Host.API_HostAddress = http://localhost:5008
+
+GET {{Host.API_HostAddress}}/weatherforecast/
+Accept: application/json
+
+###

package/BlueprintTemplate/Host.API/Program.cs

@@ -0,0 +1,25 @@
+using Host.API.Extensions;
+
+var builder = WebApplication.CreateBuilder(args);
+
+// Core
+builder.Services.AddApiCore(builder.Configuration);
+
+// Third-party
+builder.Services.AddThirdParty();
+
+// Modules
+builder.Services.AddUserModule();
+builder.Services.AddItemModule();
+builder.Services.AddSharedModule();
+
+// Database
+builder.Services.AddMySqlDatabase(builder.Configuration);
+
+var app = builder.Build();
+
+app.UseApiMiddleware();
+
+app.ApplyDatabaseMigrations();
+
+app.Run();

package/BlueprintTemplate/Host.API/Properties/launchSettings.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "http://localhost:5008",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "https://localhost:7070;http://localhost:5008",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

package/BlueprintTemplate/Host.API/appsettings.Development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

package/BlueprintTemplate/Host.API/appsettings.json

@@ -0,0 +1,15 @@
+{
+  "ConnectionStrings": {
+    "MySql": "Server=localhost;Port=3306;Database=test16;User=root;Password=password;"
+  },
+  "Database": {
+    "Type": "mysql"
+  },
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}

package/BlueprintTemplate/ItemModule.API/Controllers/Public/ItemController.cs

@@ -0,0 +1,65 @@
+using AutoMapper;
+using ItemModule.Core.Dtos.Admin;
+using ItemModule.Core.Entities;
+using ItemModule.Core.Interfaces.API;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+using Shared.Core.Shared.Models;
+using System.Diagnostics;
+
+namespace ItemModule.API.Controllers.Public
+{
+    /// <summary>
+    /// Item Controller
+    /// </summary>
+    [Route("rest/v{version:apiVersion}/items")]
+    [Produces("application/json")]
+    [ApiController]
+    public class ItemController : Controller
+    {
+        private readonly IMapper _mapper;
+        private ILogger _logger;
+        private readonly IItemService _itemService;
+
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="logger"></param>
+        /// <param name="mapper"></param>
+        /// <param name="itemService"></param>
+        public ItemController(
+            ILogger<ItemController> logger,
+            IMapper mapper,
+            IItemService itemService)
+        {
+            _mapper = mapper;
+            _logger = logger;
+            _itemService = itemService;
+        }
+
+        /// <summary>
+        /// Get items
+        /// </summary>
+        /// <param name="pagingParams"></param>
+        /// <returns></returns>
+        [HttpGet]
+        [ProducesResponseType(typeof(PagerData<ItemResponseDto>), StatusCodes.Status200OK)]
+        public async Task<IActionResult> GetItems([FromQuery] PagingParams pagingParams)
+        {
+            _logger.LogInformation($"Start getting items");
+            var stopwatch = Stopwatch.StartNew();
+
+            PagerData<Item> items = await _itemService.GetItemsAsync(pagingParams);
+            PagerData<ItemResponseDto> itemResponse = _mapper.Map<PagerData<ItemResponseDto>>(items);
+
+            // Add custom headers
+            Response.Headers.Append("X-WP-Total", items.TotalRecords.ToString());
+
+            stopwatch.Stop();
+            _logger.LogInformation($"Getting items done in {stopwatch.ElapsedMilliseconds}");
+
+            return Ok(itemResponse.Items);
+        }
+    }
+}

package/BlueprintTemplate/ItemModule.API/ItemModule.API.csproj

@@ -0,0 +1,26 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Folder Include="Controllers\Admin\" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Asp.Versioning.Mvc" Version="8.1.1" />
+    <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.1.1" />
+    <PackageReference Include="AutoMapper" Version="16.0.0" />
+    <PackageReference Include="Microsoft.AspNetCore.Authorization" Version="10.0.2" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="2.3.9" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\ItemModule.Core\ItemModule.Core.csproj" />
+    <ProjectReference Include="..\Shared.Core\Shared.Core.csproj" />
+  </ItemGroup>
+
+</Project>

package/BlueprintTemplate/ItemModule.API/Mappers/DtoItemMappingProfile.cs

@@ -0,0 +1,26 @@
+using AutoMapper;
+using ItemModule.Core.Dtos.Admin;
+using ItemModule.Core.Entities;
+using Shared.Core.Shared.Models;
+
+namespace ItemModule.API.Mappers
+{
+    /// <summary>
+    /// DtoItemMappingProfile
+    /// </summary>
+    public class DtoItemMappingProfile : Profile
+    {
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        public DtoItemMappingProfile()
+        {
+            CreateMap<Item, ItemRequestDto>().ReverseMap();
+
+            CreateMap<PagerData<Item>, PagerData<ItemResponseDto>>().ReverseMap();
+
+            CreateMap<Item, ItemResponseDto>()
+                .ReverseMap();
+        }
+    }
+}

package/BlueprintTemplate/ItemModule.Core/Dtos/Admin/ItemRequestDto.cs

@@ -0,0 +1,8 @@
+using Shared.Core.Dtos.Requests;
+
+namespace ItemModule.Core.Dtos.Admin
+{
+    public class ItemRequestDto : BaseRequestDto
+    {
+    }
+}

package/BlueprintTemplate/ItemModule.Core/Dtos/Admin/ItemResponseDto.cs

@@ -0,0 +1,8 @@
+using Shared.Core.Dtos.Responses;
+
+namespace ItemModule.Core.Dtos.Admin
+{
+    public class ItemResponseDto : BaseResponseDto
+    {
+    }
+}

package/BlueprintTemplate/ItemModule.Core/Entities/Item.cs

@@ -0,0 +1,8 @@
+using Shared.Core.Entities;
+
+namespace ItemModule.Core.Entities
+{
+    public class Item : BaseEntity
+    {
+    }
+}

package/BlueprintTemplate/ItemModule.Core/Interfaces/API/IItemService.cs

@@ -0,0 +1,9 @@
+using ItemModule.Core.Entities;
+using Shared.Core.Interfaces.API;
+
+namespace ItemModule.Core.Interfaces.API
+{
+    public interface IItemService : IItemService<Item>
+    {
+    }
+}

package/BlueprintTemplate/ItemModule.Core/Interfaces/SPI/IItemInfra.cs

@@ -0,0 +1,9 @@
+using ItemModule.Core.Entities;
+using Shared.Core.Interfaces.SPI;
+
+namespace ItemModule.Core.Interfaces.SPI
+{
+    public interface IItemInfra : IItemInfra<Item>
+    {
+    }
+}

package/BlueprintTemplate/ItemModule.Core/ItemModule.Core.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Shared.Core\Shared.Core.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Folder Include="Dtos\Public\" />
+    <Folder Include="Enums\" />
+  </ItemGroup>
+
+</Project>

package/BlueprintTemplate/ItemModule.Core/Services/ItemService.cs

@@ -0,0 +1,20 @@
+using ItemModule.Core.Entities;
+using ItemModule.Core.Interfaces.API;
+using ItemModule.Core.Interfaces.SPI;
+using Microsoft.Extensions.Logging;
+using Shared.Core.Interfaces.SPI;
+using Shared.Core.Services;
+
+namespace ItemModule.Core.Services
+{
+    public class ItemService : ItemService<Item>, IItemService
+    {
+        private readonly IItemInfra _userInfra;
+        public ItemService(ILogger<ItemService> logger,
+            IRepositoryFactory<Item> repositoryFactory,
+            IItemInfra userInfra) : base(logger, repositoryFactory)
+        {
+            _userInfra = userInfra;
+        }
+    }
+}

package/BlueprintTemplate/ItemModule.Infrastructure/Database/ItemConfiguration.cs

@@ -0,0 +1,22 @@
+using ItemModule.Core.Entities;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Metadata.Builders;
+
+namespace ItemModule.Infrastructure.Database
+{
+    internal class ItemConfiguration : IEntityTypeConfiguration<Item>
+    {
+        public void Configure(EntityTypeBuilder<Item> builder)
+        {
+            // Table
+            builder.ToTable("Items");
+
+            // Primary key
+            builder.HasKey(x => x.Id);
+
+            // BaseEntity (nếu có)
+            builder.Property(x => x.Id)
+                   .IsRequired();
+        }
+    }
+}

package/BlueprintTemplate/ItemModule.Infrastructure/Database/Seeder.cs

@@ -0,0 +1,21 @@
+using ItemModule.Core.Entities;
+using Microsoft.EntityFrameworkCore;
+using Shared.Core.Enums;
+using Shared.Core.Interfaces.SPI;
+
+namespace ItemModule.Infrastructure.Database
+{
+    public class Seeder : IModuleSeeder
+    {
+        public void Seed(ModelBuilder modelBuilder)
+        {
+            modelBuilder.Entity<Item>().HasData(
+                new Item
+                {
+                    Id = Guid.Parse("11111111-1111-1111-1111-111111111111"),
+                    Status = EntityStatus.Active,
+                }
+            );
+        }
+    }
+}

package/BlueprintTemplate/ItemModule.Infrastructure/ItemDependencyInjection.cs

@@ -0,0 +1,27 @@
+using ItemModule.Core.Interfaces.API;
+using ItemModule.Core.Interfaces.SPI;
+using ItemModule.Core.Services;
+using ItemModule.Infrastructure.Database;
+using ItemModule.Infrastructure.Services;
+using Microsoft.Extensions.DependencyInjection;
+using Shared.Core.Interfaces.API;
+using Shared.Core.Interfaces.SPI;
+using Shared.Core.Services;
+using Shared.Infrastructure.Services.MySQL;
+
+namespace ItemModule.Infrastructure
+{
+    public static class ItemDependencyInjection
+    {
+        public static IServiceCollection AddItemModuleInfra(
+            this IServiceCollection services)
+        {
+            services.AddScoped<IModuleSeeder, Seeder>();
+            services.AddScoped(typeof(IItemService<>), typeof(ItemService<>));
+            services.AddScoped(typeof(IItemInfra<>), typeof(MySQLItemInfra<>));
+            services.AddScoped<IItemInfra, MySQLItemInfra>();
+            services.AddScoped<IItemService, ItemService>();
+            return services;
+        }
+    }
+}

package/BlueprintTemplate/ItemModule.Infrastructure/ItemModule.Infrastructure.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\ItemModule.Core\ItemModule.Core.csproj" />
+    <ProjectReference Include="..\Shared.Infrastructure\Shared.Infrastructure.csproj" />
+  </ItemGroup>
+
+</Project>

package/BlueprintTemplate/ItemModule.Infrastructure/Services/MySQLItemInfra.cs

@@ -0,0 +1,16 @@
+using ItemModule.Core.Entities;
+using ItemModule.Core.Interfaces.SPI;
+using Microsoft.Extensions.Logging;
+using Shared.Infrastructure;
+using Shared.Infrastructure.Services.MySQL;
+
+namespace ItemModule.Infrastructure.Services
+{
+    public class MySQLItemInfra : MySQLItemInfra<Item>, IItemInfra
+    {
+        public MySQLItemInfra(MyDbContext dbContext, ILogger<MySQLItemInfra> logger)
+        : base(dbContext, logger)
+        {
+        }
+    }
+}

package/BlueprintTemplate/MyBlueprint.slnx

@@ -0,0 +1,23 @@
+<Solution>
+  <Folder Name="/Host/">
+    <Project Path="Host.API/Host.API.csproj" />
+  </Folder>
+  <Folder Name="/Modules/" />
+  <Folder Name="/Modules/ItemModule/">
+    <Project Path="ItemModule.API/ItemModule.API.csproj" Id="c57fa45b-2f29-43e5-b170-35ed55caec58" />
+    <Project Path="ItemModule.Core/ItemModule.Core.csproj" Id="d2c886fa-7941-46a2-bf70-c1bc63fe3ce4" />
+    <Project Path="ItemModule.Infrastructure/ItemModule.Infrastructure.csproj" Id="617cb286-de79-466b-b1bf-b103dfc716ec" />
+  </Folder>
+  <Folder Name="/Modules/UserModule/">
+    <Project Path="User.API/UserModule.API.csproj" />
+    <Project Path="User.Core/UserModule.Core.csproj" />
+    <Project Path="User.Infrastructure/UserModule.Infrastructure.csproj" />
+  </Folder>
+  <Folder Name="/Shared/">
+    <Project Path="Shared.Core/Shared.Core.csproj" />
+    <Project Path="Shared.Infrastructure/Shared.Infrastructure.csproj" />
+  </Folder>
+  <Folder Name="/Solution Items/">
+    <File Path="README.md" />
+  </Folder>
+</Solution>

package/BlueprintTemplate/README.md

@@ -0,0 +1,22 @@
+5. Tạo mới 1 project từ module: 
+	- Chạy câu lệnh blueprint
+	
+	- Sửa connection string (nếu cần)
+	- dotnet restore
+	
+6. Tạo mới 1 module
+	- Copy lại thư mục item để thêm module mới
+	- Sửa lại tên và toàn bộ namespace
+	- Sửa lại các nội dung sau (Trong Host.API): 
+		+ Đăng ký ở ServiceCollectionExtensions.cs: 
+			. Controller: .AddApplicationPart(typeof(ItemController).Assembly);
+			. Injection: ItemDependencyInjection.AddItemModuleInfra(services);
+		+ Đăng ký Mapping ở ThirdPartyExtensions.cs: typeof(DtoItemMappingProfile).Assembly,
+		+ Gọi ở Program.cs: builder.Services.AddItemModule();
+
+7. Mock Data
+	- Tools → NuGet Package Manager → Package Manager Console
+	- Default project: catalog.Infra
+	- Xóa Migration cũ
+	- Add-Migration SeedInitialData
+	- Update-Database

package/BlueprintTemplate/Shared.Core/Dtos/Requests/BaseRequestDto.cs

@@ -0,0 +1,27 @@
+using Shared.Core.Enums;
+
+namespace Shared.Core.Dtos.Requests
+{
+    /// <summary>
+    /// BaseRequestDto
+    /// </summary>
+    public class BaseRequestDto
+    {
+        /// <summary>
+        /// Id
+        /// </summary>
+        public Guid? Id { get; set; }
+        /// <summary>
+        /// Status
+        /// </summary>
+        public EntityStatus? Status { get; set; }
+        /// <summary>
+        /// Date
+        /// </summary>
+        public DateTime? Date { get; set; }
+        /// <summary>
+        /// Modified
+        /// </summary>
+        public DateTime? Modified { get; set; }
+    }
+}