Flask route as API endpoint

Introduction

A Flask route lets you create a web address that your app listens to. Using it as an API endpoint means your app can send or receive data when someone visits that address.

You want to let other programs get data from your app.

You want to let other programs send data to your app.

You want to build a simple web service that returns information.

You want to connect your app with a frontend or mobile app.

You want to test your app by calling specific URLs.

Syntax

Flask

@app.route('/path', methods=['GET', 'POST'])
def function_name():
    # code to handle request
    return response

The @app.route decorator tells Flask which URL to listen to.

The methods list defines which HTTP actions the route accepts, like GET or POST.

Examples

A simple route that returns a greeting when you visit '/hello'. It only accepts GET requests by default.

Flask

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

This route accepts POST requests with JSON data and sends back a confirmation with the data received.

Flask

from flask import request

@app.route('/data', methods=['POST'])
def receive_data():
    data = request.json
    return {'message': 'Data received', 'yourData': data}

Sample Program

This Flask app creates an API endpoint at '/api/greet'. It reads a name from the URL query and returns a friendly greeting in JSON format.

Flask

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/api/greet', methods=['GET'])
def greet():
    name = request.args.get('name', 'Guest')
    return jsonify({'message': f'Hello, {name}!'})

if __name__ == '__main__':
    app.run(debug=True)

Important Notes

Always return JSON for API endpoints to keep data easy to use.

Use request.args for GET data and request.json for POST JSON data.

Run Flask with debug=True only during development to see helpful errors.

Summary

Flask routes create web addresses your app listens to.

Use routes as API endpoints to send or receive data.

Return JSON responses for easy data exchange.

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