Respositório com API de exemplo usando FastAPI no Python
Será um projeto de to-do list, onde será possível criar, listar, atualizar e deletar tarefas. O banco de dados utilizado será o PostgreSQL.
- Criar TO-DO
- Listar TO-DOs
- Atualizar TO-DOs
- Renomear
- Marcar como completo/incompleto
- Apagar TO-DO
Esse projeto de exemplo usa Pipenv como gerenciador de dependências. Você precisa ter o Pipenv instalado na sua máquina para rodar o projeto.
Para instalar o Pipenv, você pode usar o comando:
pip install --user pipenv
Important
Para informações detalhadas sobre como instalar e usar o Pipenv, consulte a documentação oficial.
Para instalar as dependências do projeto, você pode usar o comando:
pipenv sync
Esse comando instala todas as dependências do projeto, incluindo as dependências de desenvolvimento, declaradas no arquivo Pipfile
.
Para rodar o projeto no modo desenvolvimento, você pode usar o comando:
pipenv run dev
Esse comando inicia o servidor de desenvolvimento do FastAPI. Você pode acessar a documentação da API em http://localhost:8000/docs
.
.
├── .devcontainer/ # Configurações do DevContainer
│ ├── devcontainer.json # Configurações do DevContainer
│ └── post-start.sh # Script de pós-start do DevContainer
├── app/ # Código fonte da aplicação
│ ├── models/ # Modelos de dados
│ │ ├── database.py # Modelos de entidades do banco de dados
│ │ └── dto.py # Modelos de transferência de dados (Data-Transfer Objects)
│ ├── routes/ # Rotas da API
│ ├── main.py # Arquivo principal da aplicação
│ └── database.py # Configuração do banco de dados
├── .gitignore # Arquivos e diretórios ignorados pelo Git
├── Pipfile # Arquivo de definição de dependências e scripts
├── Pipfile.lock # Arquivo de lock das dependências
└── README.md # Documentação do projeto
- FastAPI: https://fastapi.tiangolo.com/
- Pipenv: https://pipenv.pypa.io/en/latest/
- Pydantic: https://docs.pydantic.dev/latest/