MyWebAPITemplate

Mi plantilla de API web

Plantilla de inicio para todo tipo de API REST con ASP.NET Core

Este es mi obstinado trabajo constantemente en progreso, plantilla de inicio, para construir API REST.

Esta plantilla es para usted si solo desea comenzar con la codificación, desea una estructura de proyecto ya pensada, que es bastante simple y rápida de aprender, y funciona en proyectos cada vez más grandes bien.

Detalles

Tecnologías, marcos y bibliotecas

• Lenguaje de programación: C#
• Framework: ASP.NET Core 7 (siempre la última versión)
• Base de datos: SQL Server (también es posible usar otras bases de datos)
• ORM: Marco de entidad
• Pruebas: XUnit, MOQ y FluentAspertions

Arquitectura, características y patrones

• Aplicación de proceso único (monolítico)
• Arquitectura de limpieza/cebolla
• Sigue los principios de API REST más habituales
• Estructura de código que maneja los casos de uso más típicos con la escala en mente
• Swagger/Openapi con ui
• Desarrollo/QA/Configuraciones de producción
• Semilla de base de datos
• Manejo de errores globales
• Mapeo de modelos
• Validaciones
• Pruebas integrales (pruebas funcionales, de integración y unidad)
• Explotación florestal
• Patrón de repositorio
• Soporte de Docker
• .. y más en la cartera

Estructura de carpeta de plantilla

 app                               -> App and related files
 ├─> src                          -> App source
 │   ├─> Web                      -> Entry point for API - runnable project
 │   │   ├─> Controllers          -> API endpoints
 │   │   ├─> Extensions           -> Extension methods
 │   │   ├─> Interfaces           -> Web project's interfaces
 │   │   ├─> Mappers              -> Model mappers
 │   │   ├─> Middlewares          -> Middlewares (e.g. global error handling)
 │   │   |─> Models               -> Models in and out of API
 │   │   ├─> Settings             -> Options pattern for App (e.g. connection strings)
 │   │   ├─> Validators           -> Model validation rules
 │   │   ├── Program.cs           -> START
 │   │   └── Startup.cs           -> START
 │   ├─> Core                     -> Holds business logic
 │   │   ├─> Dtos                 -> Data-transfer-object (used for business logic)
 │   │   ├─> Entities             -> Entity Framework entities for database 
 │   │   ├─> Interfaces           -> Core project's interfaces
 │   │   ├─> Mappers              -> Dto and Entity mappers
 │   │   ├─> Services             -> Business logic services
 │   └─> Infrastructure           -> Data access and external services 
 │       ├─> Database             -> Database access
 │       │   ├─> Configurations   -> Entity Framework table configurations
 │       │   ├─> Migrations       -> Entity Framework autogenerated migrations
 │       │   ├─> Repositories     -> Repository pattern
 │       │   ├── AppDbContext.cs  -> Base context
 │       │   ├── AppSeed.cs       -> Database seeding
 │       │   └── EfRepository.cs  -> Base repository
 │       └─> ExternalServices     -> Services that access external services (e.g. ext. email service)
 └─> tests                        -> App tests
     ├── FunctionalTests          -> Endpoint tests etc.
     │   ├─> Tests                -> All tests
     │   └─> Utils                -> Utility functions (e.g. test database setup)
     ├── IntegrationTests         -> Database tests etc.
     │   ├─> Tests                -> All tests
     │   ├─> Utils                -> Utilities functions (e.g. test database setup)
     ├── UnitTests                -> Application logic tests etc.  
     │   ├─> Tests                -> All tests
     │   ├─> Utils                -> Utility functions 
     └── Shared                   -> Model builders and other shared functions for tests

Uso

En Windows

1. Descargue el último SDK .NET (https://dotnet.microsoft.com/download)
2. Al ejecutar la primera vez , inicializar la base de datos

   •  dotnet tool install --global dotnet-ef
     dotnet ef database update -c ApplicationDbContext -p . /src/Infrastructure/Infrastructure.csproj -s . /src/Web/Web.csproj

3. Lanzamiento
   • Opción 1. Iniciar Visual Studio
     1. Abra con MyWebAPITemplate.sln
     2. Presione F5 o Debug/Start Debugging
   • Opción 2. Iniciar en CLI

     1.  dotnet run -p . /src/Web/

4. Navegue a https: // localhost: 5001/swagger/index.html

Multiplataforma con Docker (en progreso)

1. Actualmente solo es posible con la memoria

Nuevas migraciones de bases de datos

Cuando necesite crear una nueva migración (cuando cambie el esquema de la base de datos), ejecute este comando para decirle al marco de entidad para manejar los cambios de esquema necesarios para la base de datos.

 dotnet ef migrations add NewMigrationNameHere --context ApplicationDbContext -p . /src/Infrastructure/Infrastructure.csproj -s . /src/Web/Web.csproj -o Database /Migrations 

Motivación

Este proyecto comenzó como mi forma de manejar el flujo de información de todo lo que debe hacerse al construir API con una sola manera monolítica. Hay tantas cosas para recordar y hay una gran cantidad de opciones para tomar. Por lo tanto, hice esta plantilla, para mí, para almacenar todas las prácticas que he encontrado prácticas y espero que esta plantilla también ayude a alguien más a aprender una o dos cosas.

En esta plantilla, he recopilado mi conocimiento de la construcción de API en un formato práctico. Las preferencias arquitectónicas, las selecciones de la biblioteca y otras opciones se realizan, basadas en las mejores prácticas, popularidad y mis propias preferencias obstinadas. El propósito de esta plantilla es proporcionar un buen ejemplo básico sobre cómo construir API REST con ASP.NET que sean escalables, fáciles de mantener y contienen configuraciones necesarias y otras golosinas. Esta plantilla está inspirada en la aplicación de referencia de Microsoft EshopoB y muchas otras.

Objetivos

• Para mejorar la plantilla cada vez que encuentro algo útil, o se me ocurren una nueva mejor manera de manejar alguna parte del programa.
• Para usar solo conceptos o tecnologías que ya he usado en algunos de mis proyectos anteriores, por lo que sé si valen la pena. Este proyecto no es para jugar todas las cosas experimentales, hay otros proyectos para eso :)
• Para mantener la estructura simple, pero no demasiado simple. Esta estructura del proyecto puede parecer un poco exagerada para la aplicación TODO, pero la estructura está aquí para mostrar una forma de manejar la estructura del código en proyectos más grandes. La estructura del código debe poder manejar sistemas más grandes con mayor cantidad de código y características.
• Para mantener la plantilla como "monolítica", porque creo que esta podría ser la mejor manera de comenzar un nuevo proyecto. Leer más aquí
• Ser obstinado, pero siempre creo estar listo para cambiar cualquier cosa si hay una mejor manera de hacer

Contribuyente y licencia

Este proyecto tiene licencia MIT, así que siéntase libre de usarlo de todos modos que desee. Las sugerencias y la ayuda son bienvenidas. ?