RegistrosFuncionariosAPI

Esta Interface de Programação de Aplicação (API) proporciona as 4 principais operações para controlar registros de funcionários em um banco de dados SGBD MySQL, o famoso CRUD:

• Create ➔ Cadastrar informações de um funcionário
• Read ➔ Consultar informações de um funcionário
• Update ➔ Modificar informações de um funcionário
• Delete ➔ Anular registro de um funcionário

---

📘 Documentação

Acesse a documentação da RegistrosFuncionariosAPI para saber mais sobre a API e como utilizá-la.

Disponível em: https://registros-funcionarios-api-docs.luishperna.com.br

---

🚘 URLs - Rotas

Rotas (endpoint) para acesso à RegistrosFuncionariosAPI:

1. Home

   URL https://registros-funcionarios-api.luishperna.com.br

2. Swagger UI/OpenAPI

   URL https://registros-funcionarios-api.luishperna.com.br/docs

   URL https://registros-funcionarios-api.luishperna.com.br/openapi.json

3. Status

   URL https://registros-funcionarios-api.luishperna.com.br/status

4. Cadastros

   URL https://registros-funcionarios-api.luishperna.com.br/funcionarios/cadastros

5. Consultas

   URL https://registros-funcionarios-api.luishperna.com.br/funcionarios/consultas/{cpf}

6. Modificações

   URL https://registros-funcionarios-api.luishperna.com.br/funcionarios/modificacoes

7. Anulações

   URL https://registros-funcionarios-api.luishperna.com.br/funcionarios/anulacoes/{cpf}

---

↔️ Compatibilidade

A RegistrosFuncionariosAPI utiliza do formato JSON para realizar as comunicações entre os sistemas, assim facilitando o tráfego de dados entre aplicações distintas e havendo um ponto em comum entre diversas linguagens de programação.

---

⚠️ Finalidade da API

A API foi desenvolvida com a finalidade de simular uma aplicabilidade em uma empresa fictícia, sendo assim, não apresentando usabilidade real.

O foco da RegistrosFuncionariosAPI é apenas para fins de estudo pessoal sobre Interface de Programação de Aplicações.

---

🚫 Restrição do uso da API

A utilização da RegistrosFuncionariosAPI está restrita apenas para testes ou fins de estudo sobre consumo de API, visto que os dados inseridos poderam ser acessados, alterados ou apagados por qualquer usuário com acesso a API.

Além disso, a API e o banco de dados estão sujeitos a paradas ou desligamento por fatores externos, como os serviços de hospedagens utilizados para o deploy das aplicações.

---

👨‍💻 Tecnologias utilizadas

• Linguagem de Programação: python

• Framework Web: FastAPI

• Validação de Dados: pydantic

• Servidor Web ASGI: uvicorn

• SGBD: MySQL

• Driver MySQL: mysql-connector-python

• Gerenciamento Variáveis de Ambiente: python-dotenv

• Hospedagem/Deploy:

  • API: Vercel
  • MySQL: TiDB Cloud

• Editor de Código/IDE: visual studio code

• Versionamento e repositório remoto: git github

---

Autor

Luís Henrique Perna