|
| 1 | +# Usuarios API .NET |
| 2 | + |
| 3 | +Exemplo do mesmo CRUD de usuarios da pasta `python`, agora implementado em .NET 10 com ASP.NET Core Minimal API, Swagger, persistencia em memoria, testes automatizados e arquitetura Ports and Adapters. |
| 4 | + |
| 5 | +## Tecnologias |
| 6 | + |
| 7 | +- .NET 10 |
| 8 | +- ASP.NET Core Minimal API |
| 9 | +- Swagger UI |
| 10 | +- xUnit |
| 11 | + |
| 12 | +## Pre-requisitos |
| 13 | + |
| 14 | +- Windows com PowerShell |
| 15 | +- .NET SDK 10 instalado |
| 16 | + |
| 17 | +Para validar a instalacao: |
| 18 | + |
| 19 | +```powershell |
| 20 | +dotnet --list-sdks |
| 21 | +``` |
| 22 | + |
| 23 | +## Arquitetura |
| 24 | + |
| 25 | +Estrutura da solucao: |
| 26 | + |
| 27 | +```text |
| 28 | +src/ |
| 29 | +|-- Usuarios.Api |
| 30 | +|-- Usuarios.Application |
| 31 | +|-- Usuarios.Domain |
| 32 | +`-- Usuarios.Adapters |
| 33 | +
|
| 34 | +tests/ |
| 35 | +`-- Usuarios.Tests |
| 36 | +``` |
| 37 | + |
| 38 | +Responsabilidades: |
| 39 | + |
| 40 | +- `Usuarios.Domain`: entidade, excecoes e porta de repositorio |
| 41 | +- `Usuarios.Application`: servico de aplicacao e comando de entrada |
| 42 | +- `Usuarios.Adapters`: implementacao em memoria do repositorio |
| 43 | +- `Usuarios.Api`: endpoints Minimal API, Swagger e composicao da aplicacao |
| 44 | +- `Usuarios.Tests`: testes de servico e de API |
| 45 | + |
| 46 | +## Estilo da API |
| 47 | + |
| 48 | +A camada HTTP da versao .NET agora usa Minimal API em vez de controllers MVC. |
| 49 | + |
| 50 | +Isso significa que: |
| 51 | + |
| 52 | +- os endpoints sao mapeados diretamente no startup da aplicacao |
| 53 | +- o contrato HTTP continua o mesmo da versao anterior |
| 54 | +- a estrutura continua separada por camadas, sem misturar regra de negocio com a borda HTTP |
| 55 | + |
| 56 | +Arquivos principais da borda HTTP: |
| 57 | + |
| 58 | +- `src/Usuarios.Api/Program.cs` |
| 59 | +- `src/Usuarios.Api/Endpoints/HealthEndpoints.cs` |
| 60 | +- `src/Usuarios.Api/Endpoints/UserEndpoints.cs` |
| 61 | + |
| 62 | +## Modelo de dominio |
| 63 | + |
| 64 | +- `id: int` |
| 65 | +- `nome: string` |
| 66 | +- `dtNascimento: date` |
| 67 | +- `status: bool` |
| 68 | +- `telefones: string[]` |
| 69 | + |
| 70 | +## Como rodar |
| 71 | + |
| 72 | +Na pasta `dotnet`: |
| 73 | + |
| 74 | +### 1. Restaurar dependencias |
| 75 | + |
| 76 | +```powershell |
| 77 | +dotnet restore |
| 78 | +``` |
| 79 | + |
| 80 | +### 2. Rodar a API |
| 81 | + |
| 82 | +```powershell |
| 83 | +dotnet run --project .\src\Usuarios.Api\Usuarios.Api.csproj |
| 84 | +``` |
| 85 | + |
| 86 | +Por padrao, usando o `launchSettings.json` atual, a API sobe em: |
| 87 | + |
| 88 | +- API: `http://localhost:5266` |
| 89 | +- Swagger UI: `http://localhost:5266/swagger` |
| 90 | + |
| 91 | +Se a porta mudar, o `dotnet run` vai mostrar a URL correta no terminal. |
| 92 | + |
| 93 | +### 3. Build de validacao |
| 94 | + |
| 95 | +```powershell |
| 96 | +dotnet build .\UsuariosApi.slnx |
| 97 | +``` |
| 98 | + |
| 99 | +## Como testar |
| 100 | + |
| 101 | +```powershell |
| 102 | +dotnet test .\UsuariosApi.slnx --collect:"XPlat Code Coverage" |
| 103 | +``` |
| 104 | + |
| 105 | +Resultado esperado no estado atual do projeto: |
| 106 | + |
| 107 | +- testes de servico |
| 108 | +- testes de API |
| 109 | +- 9 testes passando |
| 110 | + |
| 111 | +## Endpoints |
| 112 | + |
| 113 | +- `GET /health/live` |
| 114 | +- `GET /health/ready` |
| 115 | +- `POST /usuarios` |
| 116 | +- `GET /usuarios` |
| 117 | +- `GET /usuarios/{usuarioId}` |
| 118 | +- `PUT /usuarios/{usuarioId}` |
| 119 | +- `DELETE /usuarios/{usuarioId}` |
| 120 | + |
| 121 | +## Exemplo de payload |
| 122 | + |
| 123 | +```json |
| 124 | +{ |
| 125 | + "id": 1, |
| 126 | + "nome": "Carlos", |
| 127 | + "dtNascimento": "1992-03-14", |
| 128 | + "status": true, |
| 129 | + "telefones": [ |
| 130 | + "11911112222", |
| 131 | + "1122223333" |
| 132 | + ] |
| 133 | +} |
| 134 | +``` |
| 135 | + |
| 136 | +## CI |
| 137 | + |
| 138 | +O workflow fica em `.github/workflows/ci.yml` e executa: |
| 139 | + |
| 140 | +- restore |
| 141 | +- build |
| 142 | +- testes |
| 143 | + |
| 144 | +## Observacoes |
| 145 | + |
| 146 | +- A persistencia e totalmente em memoria. |
| 147 | +- Ao reiniciar a aplicacao, os dados sao perdidos. |
| 148 | +- O endpoint `/health/ready` retorna `503` se o servico principal nao estiver registrado. |
| 149 | + |
| 150 | +## Comandos uteis |
| 151 | + |
| 152 | +```powershell |
| 153 | +dotnet restore |
| 154 | +dotnet build .\UsuariosApi.slnx |
| 155 | +dotnet test .\UsuariosApi.slnx |
| 156 | +dotnet run --project .\src\Usuarios.Api\Usuarios.Api.csproj |
| 157 | +``` |
0 commit comments