C# API Tutorial - Cadastro de Pessoas

Este projeto é um tutorial prático criado por Daniel Lim-Apo, que demonstra como construir uma API RESTful completa utilizando .NET 10 e C#.

📖 Sobre o Projeto

O objetivo deste projeto é fornecer um exemplo claro e direto de como implementar uma API para o gerenciamento de um cadastro simples de Pessoas. Ele foi desenvolvido com as melhores práticas iniciais de desenvolvimento web com o ecossistema .NET, incluindo uso do Swagger para documentação e uma estrutura em camadas (Controllers e Models).

🚀 Tecnologias Utilizadas

• .NET 10
• C#
• ASP.NET Core Web API
• Swagger / OpenAPI para documentação interativa da API
• Docker para conteinerização da aplicação

🏗️ Estrutura do Projeto

A solução está localizada na pasta src/WebApiDotnetExample e é composta pelos seguintes componentes principais:

• Model/Pessoa.cs: Representa a entidade base da aplicação. Uma Pessoa possui propriedades como Id, Nome, CPF, Email e DataDeNascimento.
• Controllers/PessoaController.cs: O coração da API. Este controlador expõe os endpoints HTTP necessários para realizar as operações CRUD (Create, Read, Update, Delete) em memória.
• Program.cs: Arquivo de configuração de inicialização da aplicação, onde os serviços são registrados e o pipeline HTTP é configurado (incluindo o Swagger).
• Dockerfile: Arquivo de configuração para criar uma imagem Docker da API.

🔌 Endpoints Disponíveis

A API expõe as seguintes rotas sob o caminho /api/Pessoa:

• GET /api/Pessoa: Retorna a lista completa de todas as pessoas cadastradas.
• GET /api/Pessoa/{id}: Retorna os detalhes de uma pessoa específica, buscando pelo seu ID.
• POST /api/Pessoa: Cria um novo registro de pessoa. É necessário enviar os dados no corpo da requisição (JSON).
• PUT /api/Pessoa/{id}: Atualiza os dados de uma pessoa existente.
• DELETE /api/Pessoa/{id}: Remove uma pessoa do cadastro com base no seu ID.

🛠️ Como Executar

Você pode executar o projeto de duas maneiras principais:

Opção 1: Usando o .NET CLI

1. Navegue até a pasta do projeto:

   cd src/WebApiDotnetExample

2. Execute o comando de compilação e execução:

   dotnet run

3. Ao executar (se for no ambiente de Desenvolvimento), o Swagger estará disponível para você testar a API no navegador através do endereço http://localhost:<porta>/swagger.

Opção 2: Usando Docker

(Antes é preciso iniciar o docker na máquina, através do Docker Desktop).

1. A partir do diretório do projeto, construa a imagem Docker:

   cd src/WebApiDotnetExample
   docker build -t csharp-api-tutorial .

2. Execute o contêiner:

   docker run -d -p 8080:8080 -p 8081:8081 --name api-tutorial csharp-api-tutorial