Flask route as API endpoint - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Flask route?

A Flask route is a URL pattern that tells Flask which function to run when a user visits that URL. It connects web addresses to Python functions.

beginner

How do you define a route in Flask to respond to a GET request?

Use the @app.route decorator with the URL path and set methods=['GET']. For example:
@app.route('/api/data', methods=['GET'])

beginner

What does the function decorated by a Flask route return?

It returns the response sent to the client. This can be a string, JSON data, or an HTML page.

intermediate

How do you return JSON data from a Flask route?

Use Flask's jsonify function to convert Python data to JSON and send it as a response.
Example:
return jsonify({'key': 'value'})

intermediate

Why is it important to specify HTTP methods in Flask routes?

Specifying methods like GET or POST tells Flask which types of requests the route can handle. This helps organize API behavior and improves security.

Which decorator is used to create a route in Flask?

A @app.route

B @app.endpoint

C @app.url

D @app.path

The @app.route decorator defines a URL route in Flask.

How do you specify that a Flask route should only accept POST requests?

A methods=['POST'] in @app.route

B method='POST' in @app.route

C post=True in @app.route

D Only by naming the function post_

You specify allowed HTTP methods using methods=['POST'] in the route decorator.

What does the Flask function jsonify do?

A Defines a new route

B Converts Python data to JSON response

C Starts the Flask server

D Handles form data

jsonify converts Python dictionaries or lists into JSON format for API responses.

If you want a route to respond to both GET and POST requests, how do you specify it?

A methods='GET, POST'

B methods='both'

C methods=['GET POST']

D methods=['GET', 'POST']

You list allowed methods as a list: methods=['GET', 'POST'].

What will happen if you visit a Flask route URL that only accepts POST but you send a GET request?

A Flask returns a 404 Not Found error

B Flask runs the route anyway

C Flask returns a 405 Method Not Allowed error

D Flask crashes

Flask returns a 405 error when the HTTP method is not allowed for the route.

Explain how to create a simple Flask API endpoint that returns JSON data when accessed via a GET request.

Think about how you connect a URL to a function and send back JSON.

Describe why specifying HTTP methods in Flask routes is important for API design.

Consider what happens if you don't limit request types.

Practice

1. What does a Flask route do in a web application?

easy

A. It styles the webpage with CSS.

B. It stores data in a database automatically.

C. It compiles Python code into machine code.

D. It defines a URL where the app listens for requests.

Solution

1. Step 1: Understand the role of a route

   A Flask route sets a specific web address that the app listens to for incoming requests.

2. Step 2: Identify what routes do not do

   Routes do not handle styling, database storage automatically, or code compilation.

3. Final Answer:

   It defines a URL where the app listens for requests. -> Option D

4. Quick Check:

   Flask route = URL listener [OK]

Hint: Routes map URLs to functions handling requests [OK]

Common Mistakes:

• Thinking routes handle styling or database storage
• Confusing routes with frontend design
• Assuming routes compile code

2. Which of the following is the correct syntax to create a Flask route for the URL '/api/data'?

easy

A. @app.route('/api/data')\ndef get_data():\n return 'data'

B. @app.route('/api/data')\nfunction get_data() { return 'data'; }

C. app.route('/api/data')\ndef get_data():\n return 'data'

D. @app.route('/api/data')\ndef get_data():\nprint('data')

Solution

1. Step 1: Check Flask route decorator syntax

   The correct syntax uses @app.route('/api/data') above a Python function definition.

2. Step 2: Verify function and return statement

   The function must be defined with def and return a value; print does not send a response.

3. Final Answer:

   @app.route('/api/data')\ndef get_data():\n return 'data' -> Option A

4. Quick Check:

   Python route decorator + def + return = D [OK]

Hint: Use @app.route decorator and def function with return [OK]

Common Mistakes:

• Using JavaScript syntax inside Flask route
• Missing @ before app.route
• Using print instead of return in route function

3. What will be the output when accessing the '/hello' route in this Flask app?

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

@app.route('/hello')
def hello():
    return jsonify({'message': 'Hello, world!'})

medium

A. {'message': 'Hello, world!'} as JSON response

B. Plain text: Hello, world!

C. HTML page with 'Hello, world!' text

D. Error: jsonify is not defined

Solution

1. Step 1: Understand jsonify usage

   The function returns jsonify({'message': 'Hello, world!'}), which sends a JSON response.

2. Step 2: Identify response type

   The response is JSON formatted, not plain text or HTML, and no error occurs because jsonify is imported.

3. Final Answer:

   {'message': 'Hello, world!'} as JSON response -> Option A

4. Quick Check:

   jsonify returns JSON response [OK]

Hint: jsonify returns JSON, not plain text or HTML [OK]

Common Mistakes:

• Confusing jsonify with print or return string
• Expecting HTML instead of JSON
• Forgetting to import jsonify

4. Identify the error in this Flask route code:

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

@app.route('/data')
def data():
    return json({'key': 'value'})

medium

A. Missing @ before app.route decorator

B. json is not imported or defined; should use jsonify

C. Function name 'data' is invalid

D. Route URL must start with '/api/'

Solution

1. Step 1: Check function return statement

   The code uses json({'key': 'value'}) but json is not imported or defined.

2. Step 2: Identify correct function for JSON response

   Flask provides jsonify to return JSON responses, which is imported here.

3. Final Answer:

   json is not imported or defined; should use jsonify -> Option B

4. Quick Check:

   Use jsonify, not json, for JSON response [OK]

Hint: Use jsonify, not json, to return JSON in Flask [OK]

Common Mistakes:

• Using json instead of jsonify
• Forgetting to import jsonify
• Assuming function names must follow special rules

5. You want to create a Flask API endpoint '/user/' that returns JSON with the user's id and a greeting message. Which code correctly implements this?

hard

A. @app.route('/user/')\ndef user():\n return jsonify({'id': id, 'message': 'Hello user'})

B. @app.route('/user/<id>')\ndef user(id):\n return {'id': id, 'message': 'Hello user ' + id}

C. @app.route('/user/')\ndef user(id):\n return jsonify({'id': id, 'message': f'Hello user {id}'})

D. @app.route('/user/')\ndef user(id):\n print({'id': id, 'message': f'Hello user {id}'})

Solution

1. Step 1: Check route URL and parameter type

   The route uses '/user/' which correctly captures an integer parameter named id.

2. Step 2: Verify function parameters and return

   The function accepts id and returns a JSON response using jsonify with the correct message format.

3. Step 3: Identify errors in other options

   @app.route('/user/<id>')\ndef user(id):\n return {'id': id, 'message': 'Hello user ' + id} misses int type and returns a dict without jsonify; @app.route('/user/')\ndef user():\n return jsonify({'id': id, 'message': 'Hello user'}) misses id parameter; @app.route('/user/')\ndef user(id):\n print({'id': id, 'message': f'Hello user {id}'}) uses print instead of return.

4. Final Answer:

   @app.route('/user/')\ndef user(id):\n return jsonify({'id': id, 'message': f'Hello user {id}'}) -> Option C

5. Quick Check:

   Route with int param + jsonify return = A [OK]

Hint: Use in route and return jsonify with id [OK]

Common Mistakes:

• Not specifying for integer parameter
• Returning dict without jsonify
• Using print instead of return in route