Ferramentas para Desenvolvedores em C# com .NET 7, Entity Framework, SQL Server, Swagger e docker
Esta é uma API REST desenvolvida em C# com o framework .NET 7, usando Entity Framework e SQL Server como banco de dados. O principal objetivo desta API é fornecer uma coleção de ferramentas úteis para desenvolvedores, facilitando tarefas comuns e recorrentes no desenvolvimento de software.
A API oferece as seguintes funcionalidades:
- Rota para gerar números de CPF aleatórios válidos, úteis para testes e simulações.
- Rota para validar a autenticidade de números de CPF ou CNPJ, garantindo a integridade dos dados, será necessário fornecer o tipo do documento na requisição.
- Rota para criar identificadores únicos globalmente (GUIDs), essenciais para manter a integridade e unicidade dos registros em um sistema.
- Clone este repositório em sua máquina local.
- Certifique-se de ter os requisitos instalados.
- Configure a conexão com o banco de dados SQL Server no arquivo
appsettings.json
. - Execute a migração inicial para criar o esquema do banco de dados.
dotnet ef database update
- Inicie o aplicativo.
dotnet run
Acesse a API através do seu navegador ou cliente REST, como o Postman ou Insomnia.
A documentação da API está disponível através do Swagger. Para acessá-la, siga os passos abaixo:
-
Certifique-se de que o aplicativo está em execução.
-
Abra um navegador da web e acesse o seguinte URL:
{ambiente}/api/v1/documentation/index.html
Substitua {ambiente}
pela porta em que o aplicativo está sendo executado, exemplo: https://localhost:8080
HttpPost {ambiente}/api/uteis/gerar/Cpf
- Gera um CPF aleatório.HttpPost {ambiente}/api/v1/uteis/validar/documento
- Valida CPF ou CNPJ.HttpPost {ambiente}/api/v1/uteis/Guid{quantidadeGuids}
- Gera GUID conforme a quantidade desejada.
Se preferir, você também pode executar a aplicação em um contêiner Docker. Certifique-se de que o Docker esteja instalado em sua máquina e siga os passos abaixo:
-
Clone este repositório em sua máquina local.
-
Navegue até o diretório do projeto.
-
Execute o seguinte comando para criar a imagem Docker:
docker build -t nome-da-imagem
docker run -d -p PORTA:PORTA nome-da-imagem
Lembre-se de substituir PORTA
pelo número da porta que você está usando em sua aplicação e nome-da-imagem
pelo nome da imagem Docker que deseja atribuir.
HttpPost {ambiente}/api/status
- Status.HttpPost {ambiente}/api/api/dashboard
- dashboard.
Fique à vontade para contribuir para este projeto. Se você tiver ideias para novas ferramentas ou melhorias, sinta-se à vontade para abrir uma issue ou enviar um pull request.
Este projeto está sob a licença MIT. Consulte o arquivo LICENSE para obter detalhes.
Esperamos que esta API seja uma valiosa adição ao seu conjunto de ferramentas de desenvolvimento! Se você tiver alguma dúvida ou precisar de assistência, não hesite em entrar em contato conosco.