Giter Club home page Giter Club logo

auxiliar.api's Introduction

API REST AUXILIAR

Ferramentas para Desenvolvedores em C# com .NET 7, Entity Framework, SQL Server, Swagger e docker

.NET Entity Framework SQL Server Swagger 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.

Funcionalidades Principais

A API oferece as seguintes funcionalidades:

Geração de CPF Aleatório

  • Rota para gerar números de CPF aleatórios válidos, úteis para testes e simulações.

Validação de documento (CPF ou CNPJ)

  • 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.

Geração de IDs GUID

  • Rota para criar identificadores únicos globalmente (GUIDs), essenciais para manter a integridade e unicidade dos registros em um sistema.

Requisitos

Rodando local

  1. Clone este repositório em sua máquina local.
  2. Certifique-se de ter os requisitos instalados.
  3. Configure a conexão com o banco de dados SQL Server no arquivo appsettings.json.
  4. Execute a migração inicial para criar o esquema do banco de dados.
dotnet ef database update

Como Usar

  1. Inicie o aplicativo.
    dotnet run

Acesse a API através do seu navegador ou cliente REST, como o Postman ou Insomnia.

Documentação da API

A documentação da API está disponível através do Swagger. Para acessá-la, siga os passos abaixo:

  1. Certifique-se de que o aplicativo está em execução.

  2. 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

Rotas da API

  • 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.

Docker

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:

  1. Clone este repositório em sua máquina local.

  2. Navegue até o diretório do projeto.

  3. 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.

Rotas HealthCheck

  • HttpPost {ambiente}/api/status - Status.
  • HttpPost {ambiente}/api/api/dashboard - dashboard.

Contribuição

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.

Licença

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.

auxiliar.api's People

Contributors

allcb avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.