MyWebAPITemplate

Meu modelo de API da web

Modelo de partida para todos os tipos de APIs de descanso com asp.net Core

Este é o meu opinião opinativo, constantemente trabalha em andamento, modelo de partida, para a construção de APIs de descanso.

Este modelo é para você, se você deseja começar a codificar, deseja uma estrutura de projeto já pensada, é bastante simples e rápida para aprender e funciona em projetos cada vez maiores.

Detalhes

Tecnologias, estruturas e bibliotecas

• Linguagem de programação: C#
• Framework: Asp.net Core 7 (sempre a versão mais recente)
• Banco de dados: SQL Server (também é possível usar outros bancos de dados)
• ORM: Estrutura de entidade
• Teste: Xunit, Moq e Fluentassertions

Arquitetura, recursos e padrões

• Aplicação de processo único (monolítico)
• Arquitetura de limpeza/cebola
• Segue os princípios da API de descanso mais usuais
• Estrutura de código que lida com os casos de uso mais típicos com escala em mente
• Swagger/Openapi com UI
• Configurações de desenvolvimento/controle de qualidade/produção
• Semeadura de banco de dados
• Manuseio global de erros
• Mapeamento de modelo
• Valitações
• Testes abrangentes (testes funcionais, integrados e unitários)
• Log
• Padrão do repositório
• Suporte do Docker
• ..e mais em atraso

Estrutura da pasta de modelo

 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

Nas janelas

1. Faça o download mais recente .Net Sdk (https://dotnet.microsoft.com/download)
2. Ao executar pela primeira vez - Inicialize o banco de dados

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

3. Lançar
   • Opção 1. Inicie no Visual Studio
     1. Aberto com MyWebAPITemplate.sln
     2. Pressione F5 ou Debug/Start Debugging
   • Opção 2. Iniciar na CLI

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

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

Plataforma cruzada com o Docker (em andamento)

1. Atualmente possível apenas com a memória

Novas migrações de banco de dados

Quando você precisa criar uma nova migração (quando você altera o esquema do banco de dados), execute este comando para informar à Entidade Framework para lidar com as alterações de esquema necessárias para o banco de dados.

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

Motivação

Este projeto começou como minha maneira de lidar com o fluxo de informações de tudo o que precisa ser feito ao criar APIs de maneira monolítica única. Há tantas coisas a lembrar e há uma grande quantidade de opções a serem feitas. Portanto, fiz esse modelo, para mim, para armazenar todas as práticas que achei práticas e espero que esse modelo também ajude outra pessoa a aprender uma coisa ou duas.

Neste modelo, colecionei meu conhecimento do edifício da API em formato prático. As preferências arquitetônicas, as seleções de bibliotecas e outras opções são feitas, com base nas melhores práticas, popularidade e minhas próprias preferências opinativas. O objetivo deste modelo é fornecer um bom exemplo básico sobre como criar APIs REST com ASP.NET que são escaláveis, fáceis de manter e conter as configurações necessárias e outros presentes. Este modelo é inspirado no aplicativo de referência do Microsoft eShoponweb e por muitos outros.

Metas

• Para melhorar o modelo toda vez que acho algo útil, ou invento uma nova maneira melhor de lidar com parte do programa.
• Para usar apenas conceitos ou tecnologias que eu já usei em alguns dos meus projetos anteriores, então eu sei se eles valem a pena. Este projeto não é para mexer todas as coisas experimentais, existem outros projetos para isso :)
• Para manter a estrutura simples, mas não muito simples. Essa estrutura do projeto pode parecer um pouco exagerada para o aplicativo TODO, mas a estrutura está aqui para mostrar uma maneira de lidar com a estrutura de código em projetos maiores. A estrutura do código deve ser capaz de lidar com sistemas maiores com maior quantidade de código e recursos.
• Para manter o modelo como "monolítico", porque acho que essa pode ser a melhor maneira de iniciar um novo projeto. Leia mais aqui
• Ser opinativo, mas sempre penso estar pronto para mudar qualquer coisa se houver melhor maneira de fazer

Contribuindo e licença

Este projeto está licenciado pelo MIT - então sinta -se à vontade para usá -lo de qualquer maneira que desejar. Sugestões e ajuda são bem -vindas. ?