lab-flask-I: A Jupyter Notebook repository from Ironhack-data-bcn-oct-2023

Introduction

On this lab, you will create your very first own API using Flask. You'll lern how to set up a server, stop it, and abstract your code by using endpoints. Write all the code within the same jupyter notebook cell.

Iteration 1

Start a server. For you to be able to do that, go to your-code/main.ipynb and on a notebook cell, you'll have to:

Import the necessary modules in Flask:

from flask import Flask, request, jsonify

Initialize the Flask app:

app = Flask(__name__)

Make sure you start the app:

app.run(port=9000, debug=False) # You may want to change the debug to True to avoid stopping & starting the server all the time

Your notebook cell should look like this:

from flask import Flask, request, jsonify
app = Flask(__name__)

if __name__ == "__main__":
     app.run(port=9000, debug=True)

When running, you will get a message on notebooks

- Serving Flask app '**main**' (lazy loading)
- Environment: production
  WARNING: This is a development server. Do not use it in a production deployment.
  Use a production WSGI server instead.
- Debug mode: on

Also, you'll get: * Running on http://127.0.0.1:9000 (Press CTRL+C to quit). Click the link to open that adress on the browser.

Iteration 2

Create an endpoint that returns "Hello world!". For that, you'll need two things: 1 - The endopint

@app.route("/")

2 - The function used by that endpoint

def hello_world():
    return "Hello world!"

Include these two pieces of code between the code generated on iterations 2 and 3.

Make sure your code is still running and go to your browser and refresh. You should see "Hello world!".

Iteration 3

Create an endpoint that returns a random number from 0 to 10.

Endpoint: "/random-number"
Function: def random_int
Result: a stringified int

Iteration 4

Run this on VSCode

Stop your jupyter notebook
Create a directory within your lab so that it has this structure:

your-code/
    main.ipynb
.gitignore
README.md

small-api/
    main.py
    config/
        sql_connection.py # for now empty
    tools/
        sql_queries.py #for now empty

Copy your code from your jupyter notebook into your main.py
From your terminal, run python main.py
In that terminal, you'll get feedback of your prints and the errors.
After the server is up and running you'll be able to go into your browser and access the endpoints you defined.

Submission