Lecture 35

Making simple APIs with Flask

MCS 260 Fall 2020
David Dumas

Reminders

Flask

Flask is a Python web framework. It lets you build APIs and web sites with Python.

Competitors include:

• Bottle — minimalist like Flask
• Django — huge and full-featured

Installing Flask

Using pip to install, if the interpreter name is python:

python -m pip install flask

Confirm installation by testing import in the REPL:

>>> import flask
>>>

If Flask is not installed, this will produce an error.

Decorators

Flask uses a lot of decorators, a Python feature we haven't covered yet.

Basically,

@name
def f(x,y,z):

Why decorators in Flask?

We might write a function that returns a string:

Why decorators in Flask?

We might write a function that returns a string:

Why decorators in Flask?

A Flask decorator lets us link it directly to a URL:

Why decorators in Flask?

A Flask decorator lets us link it directly to a URL:

Goal 1

Build API so that

/

returns

"Hello World".

Goal 2

Build API so that

/apple/random

returns a JSON object with info about an apple variety selected at random from a list.

Goal 2'

Build API so that

/metal/random

returns a JSON object with info about a randomly-selected metal.

Goal 3

Build API that checks whether a given word is a palindrome, so

/palindrome/test?word=banana

would return False in JSON.

Summary

• localhost refers to the host a request originates from.
• 127.0.0.1 is an address for localhost using the loopback network interface.
• http://domain.com:1234/rest/of/URL/ means to use port 1234 instead of the default (which is 80 for HTTP).
• If app is a flask.Flask object, the decorator @app.route("/path/part/of/URL/") makes a function into a URL handler.
• Flask doesn't care about names of functions that handle URLs.
• flask.jsonify converts a Python value into a suitable return value from a URL handler.