API REST desenvolvida para o Trabalho de Conclusão de Curso (TCC) de Engenharia de Computação na Faculdade Engenheiro Salvador Arena.
- Sobre
- Tecnologias
- Arquitetura / Estrutura
- Instalação e Execução
- Deploy / Ambiente de Produção
- Contribuição
- Licença
Este projeto consiste em uma API REST que serve como backend do TCC, com foco em operações CRUD, validações, autenticação e persistência de dados.
A API está hospedada em: Swagger da API
- Linguagem: C# / .NET
- Banco de dados: MongoDB
- Frameworks e bibliotecas principais: ASP.NET Core, bibliotecas de conexão com MongoDB, documentação Swagger/OpenAPI
- Licença: MIT
Estrutura típica de projeto:
/Ape.API
├── Bll/ # Lógica de negócio
├── Controllers/ # Definição dos endpoints API
├── Database/ # Acesso aos dados / banco
├── DTOs/ # Objetos de transferência
├── Entity/ # Modelos de dados
└── Properties/ Config # Arquivos de configuração (appsettings, conexão com BD etc.)
├── Program # Configuração da aplicação (middleware, rotas etc.)
- .NET SDK (net6.0)
- MongoDB em execução (local ou remoto)
- Variáveis de ambiente e configurações de conexão definidas (string de conexão com o MongoDB etc.)
-
Clonar este repositório
git clone https://github.com/lucassantuss/ape-api.git cd ape-api -
Restaurar pacotes
dotnet restore
-
Ajustar configurações (appsettings.json ou variáveis de ambiente) com a string de conexão do MongoDB
-
Iniciar a aplicação
dotnet run
-
Acessar Swagger para testar os endpoints:
http://localhost:<porta>/swagger
Hospedagem atual: Azure (App Service)
Configurações de ambiente: variáveis de conexão com banco, CORS, certificados, segurança, etc.
Contribuições são bem-vindas! Para colaborar:
- Fork este repositório
- Crie uma nova branch para sua feature ou correção (feature/nome-da-feature)
- Realize as alterações
- Submeta um Pull Request descrevendo as mudanças
Este projeto está licenciado sob a licença MIT.
Veja o arquivo MIT para mais detalhes.