FastAPI CRUD - Projeto de Estudo

Este repositório foi criado com o objetivo de estudar e implementar um CRUD utilizando Python e o framework FastAPI.

Descrição do Projeto

Este projeto consiste em uma aplicação CRUD (Create, Read, Update, Delete) desenvolvida com FastAPI. Ele serve como uma base para entender os conceitos fundamentais do framework e como trabalhar com APIs RESTful de forma eficiente.

Funcionalidades

• Criar (Create): Adicionar novos registros.
• Ler (Read): Consultar registros existentes.
• Atualizar (Update): Modificar registros existentes.
• Deletar (Delete): Remover registros.

Tecnologias Utilizadas

• Python - Linguagem principal do projeto.
• FastAPI - Framework web moderno e rápido para construção de APIs.
• Uvicorn - Servidor ASGI para rodar a aplicação.
• SQLAlchemy (opcional) - Para manipulação de banco de dados.
• SQLite (ou outro banco de dados) - Banco de dados para armazenar os dados.

Como Rodar o Projeto

Pré-requisitos

Certifique-se de ter o Python 3.9+ instalado na sua máquina.

Além disso, instale as dependências necessárias listadas no arquivo requirements.txt (caso esteja disponível). Se não houver, você pode usar os seguintes comandos para instalar o FastAPI e o Uvicorn:

pip install fastapi uvicorn

Execução

1. Clone este repositório:

   git clone https://github.com/gustavodiasdev/fastapi.git
   cd fastapi

2. Inicie a aplicação:

   uvicorn main:app --reload

3. Acesse a aplicação no navegador:

   http://127.0.0.1:8000
   

4. Para acessar a documentação interativa gerada automaticamente pelo FastAPI, utilize:

   • Swagger UI: http://127.0.0.1:8000/docs
   • Redoc: http://127.0.0.1:8000/redoc

Estrutura do Projeto

Aqui está uma visão geral da estrutura do projeto:

fastapi/
├── main.py       # Arquivo principal da aplicação
├── models.py     # Definição de modelos e classes
├── schemas.py    # Esquemas de validação e serialização
├── database.py   # Configuração do banco de dados
├── requirements.txt # Dependências do projeto
└── README.md     # Este arquivo

Contribuindo

Se você quiser contribuir com este projeto, sinta-se à vontade para abrir issues ou enviar pull requests. Toda ajuda é bem-vinda!

Licença

Este projeto é para fins de estudo e não possui uma licença específica. Caso necessário, adicione uma licença na raiz do projeto.

---

Desenvolvido por gustavodiasdev.