https://github.com/fernando-medeiros/fast-flask-api
O projeto é uma API backend com diversas funcionalidades, como autenticação de usuário, criação, deleção e curtida de postagens. Segue o contexto de uma rede social e utiliza Python, FastAPI, PostgreSQL, Pytest.
https://github.com/fernando-medeiros/fast-flask-api
api backend-api fastapi python python-api
Last synced: 9 months ago
JSON representation
O projeto é uma API backend com diversas funcionalidades, como autenticação de usuário, criação, deleção e curtida de postagens. Segue o contexto de uma rede social e utiliza Python, FastAPI, PostgreSQL, Pytest.
- Host: GitHub
- URL: https://github.com/fernando-medeiros/fast-flask-api
- Owner: Fernando-Medeiros
- License: mit
- Created: 2022-11-20T13:19:44.000Z (about 3 years ago)
- Default Branch: fastapi
- Last Pushed: 2023-02-28T23:16:56.000Z (almost 3 years ago)
- Last Synced: 2025-02-11T17:16:55.649Z (11 months ago)
- Topics: api, backend-api, fastapi, python, python-api
- Language: Python
- Homepage:
- Size: 1.52 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
README
# FastAPI
O projeto será modelado no contexto de Rede Social, afim de utilizar CRUD nas rotas e diferentes tipos de relacionamentos do banco de dados.
> - Para construir o projeto isolei cada aplicação em seu próprio ecosistema e embiente virtual.
> - [**Link do Deploy do projeto Coffee-Break** -> "Rede social minimalista" que consome essa api! \o/](https://coffee-break-network.herokuapp.com/)
- [**Tarefas**](tasks.md)
- [**Testes**](tests.md)
## Resumo
- [FastAPI](#fastapi)
- [Resumo](#resumo)
- [Funcionalidades](#funcionalidades)
- [Usuários](#usuários)
- [Segurança](#segurança)
- [Postagens](#postagens)
- [Comentários](#comentários)
- [Requisitos](#requisitos)
- [Ambiente](#ambiente)
- [Iniciar o servidor](#iniciar-o-servidor)
- [Testes](#testes)
- [Estrutura](#estrutura)
- [Modelagem do banco de dados](#modelagem-do-banco-de-dados)
---
## Funcionalidades
### Usuários
- [x] Registro
- [x] Listagem de perfil
- [x] Todos
- [x] Por @username
- [x] Atualizar dados
- [x] Acessar os dados da conta
- [x] Deletar conta
### Segurança
- [x] Autenticação
- [x] Access token
- [x] Refresh Token
- [x] Recuperar senha
- [x] Email com link e tokenJwt
- [x] Atualizar senha
### Postagens
- [x] Criação
- [x] Edição
- [x] Remoção
- [x] Listar por id
- [x] Listagem de posts
- [x] Listagem por usuário
- [ ] Listagem de posts seguidos (timeline)
- [x] Curtidas em posts
### Comentários
- [x] Criação
- [x] Edição
- [x] Remoção
- [x] Listar por id
- [x] Listagem por post
- [x] Curtidas em comentários
## Requisitos
- Git
- Python 3.10
- virtualenv ou semelhante
- Um editor de códigos como VSCode, Sublime, Vim, Pycharm ...
## Ambiente
Crie o ambiente virtual desta aplicação
```console
virtualenv .venv
```
Ative o ambiente
```console
# Linux Bash
source .venv/bin/activate
# Windows Power Shell
./.venv/bin/activate.ps1
```
Instale as dependências de desenvolvimento e teste
```console
pip install -r requirements-dev.txt
```
## Iniciar o servidor
Inicie o localhost
```console
uvicorn app:app --reload --factory
```
Acesse o docs de endpoints do Fastapi em:
http://127.0.0.1:8000/docs#/ ou http://127.0.0.1:8000/redoc/
## Testes
```console
cd tests
pytest
```
## Estrutura
```console
.
├── app
│ ├── __init__.py
│ ├── models
│ │ ├── post
│ │ │ ├── __init__.py
│ │ │ ├── like.py
│ │ │ ├── post.py
│ │ │ ├── reply.py
│ │ │ ├── request.py
│ │ │ └── response.py
│ │ ├── token
│ │ │ ├── __init__.py
│ │ │ └── token_model.py
│ │ └── user
│ │ ├── access.py
│ │ ├── birthday.py
│ │ ├── __init__.py
│ │ ├── profile.py
│ │ ├── request.py
│ │ ├── response.py
│ │ └── user.py
│ ├── routers.py
│ ├── routes
│ │ ├── auth.py
│ │ ├── controllers
│ │ │ ├── auth_controller.py
│ │ │ ├── password_controller.py
│ │ │ ├── post_controller.py
│ │ │ ├── reply_controller.py
│ │ │ └── user_controller.py
│ │ ├── password.py
│ │ ├── post.py
│ │ ├── reply.py
│ │ └── user.py
│ └── security
│ ├── backend.py
│ ├── recovery_pwd.py
│ ├── session.py
│ └── token.py
├── docs
│ ├── endpoints.png
│ ├── MBD.png
│ ├── README.md
│ ├── tasks.md
│ └── tests.md
├── LICENSE
├── Procfile
├── requirements-dev.txt
├── requirements.txt
├── runtime.txt
├── setup.py
└── tests
├── conftest.py
├── __init__.py
├── models
│ ├── __init__.py
│ ├── test_password.py
│ ├── test_post.py
│ ├── test_reply.py
│ ├── test_token.py
│ └── test_user.py
├── pytest.ini
├── routes
│ ├── __init__.py
│ ├── test_auth.py
│ ├── test_password.py
│ ├── test_post.py
│ ├── test_reply.py
│ └── test_user.py
├── unity
│ ├── __init__.py
│ └── test_token_jwt.py
└── utils
├── client.py
└── post.py
14 directories, 61 files
```
## Modelagem do banco de dados
