https://github.com/andreirech/restapi
š Creating and using a REST API in Python to work with a dataset
https://github.com/andreirech/restapi
fastapi jupyter-notebook python
Last synced: 3 months ago
JSON representation
š Creating and using a REST API in Python to work with a dataset
- Host: GitHub
- URL: https://github.com/andreirech/restapi
- Owner: AndreiRech
- Created: 2024-09-10T01:09:44.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-23T01:23:59.000Z (10 months ago)
- Last Synced: 2025-04-05T20:43:25.779Z (3 months ago)
- Topics: fastapi, jupyter-notebook, python
- Language: Jupyter Notebook
- Homepage: https://restapi-v1go.onrender.com/games
- Size: 90.7 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# š ALUNOS
- [Andrei Rech | 23102140](https://github.com/AndreiRech)
- [Urien Nolasco | 23102720](https://github.com/UrienNolasco)
# š INTRODUĆĆO
CriaĆ§Ć£o de uma FastAPI com o objetivo de realizar operaƧƵes em um conjunto de dados.
# š PRĆ REQUISITOS
Ć necessĆ”rio possuir a linguagem [Python](https://www.python.org/downloads/) instalada no computador (de preferĆŖncia 3.12.x - mas pode funcionar em superiores).
Outra ferramente muito importante Ć© o gerenciador de pacotes do Python, o [Pip](https://pypi.org/project/pip/).
# ā INICIALIZAĆĆO APLICAĆĆO
Para a realizaĆ§Ć£o do projeto, utilizamos alguns pacotes adicionais. Segue a baixo a lista de pacotes a serem instalados e seus comandos:
- *FastAPI*
```
pip install fastapi
```
- *Uvicorn*
```
pip install fastapi uvicorn
```
*Pandas*
```
pip install pandas
```
*SQLModel*
```
pip install sqlmodel
```
Com tudo instalado, informe o comando para rodar a aplicaĆ§Ć£o:
```
uvicorn app.main:app --reload
```
# CONSUMINDO A API
Para consumir a API, serƔ necessƔrio realizar acessar o arquivo **api_consumer.py**, localizado dentro da pasta *auxiliares*.
Ao acessar, o [link para a api](https://restapi-v1go.onrender.com/games) estarĆ” como variĆ”vel e serĆ” necessĆ”rio apenas rodar o cĆ³digo.
PorĆ©m, saiba que o primeiro acesso demora em torno de 1 minuto para a aplicaĆ§Ć£o voltar a ficar ativa.
# O QUE FAZER
### Parte 1
- [X] Escolher conjunto de dados
- [X] Tratar conjunto, removendo informaƧƵes desnecessƔrias
- [X] CriaĆ§Ć£o da API que permite:
- [X] Consulta
- [X] AtualizaĆ§Ć£o
- [X] InserĆ§Ć£o
- [X] DeleĆ§Ć£o
### Parte 2
- [X] Documentar o projeto utilizando Postman
- [X] Exemplos de requisiƧƵes
### Parte 3
- [X] Hospedar a API na web
### Parte 4
- [X] CriaĆ§Ć£o de um script Python que seja capaz de consumir todas as funcionalidades da API