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: 16 days 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 (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-23T01:23:59.000Z (about 2 months ago)
• Last Synced: 2024-10-10T17:21:27.930Z (about 1 month 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