Building REST APIs with Flask

REST APIs are a way for different applications to communicate over HTTP using standard methods like GET, POST, PUT, and DELETE.

Flask is widely used for building REST APIs because it is lightweight, flexible, and easy to extend.

What is a REST API?

A REST API (Representational State Transfer API) allows communication between client and server using HTTP protocols.

It uses standard methods to perform operations on resources like users, products, or posts.

Why Use Flask for APIs?

Flask provides minimal setup and allows developers to build APIs quickly without unnecessary complexity.

It gives full control over routing, request handling, and response formatting.

Installing Flask

pip install flask

bash

Creating a Basic API

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/api/hello')
def hello():
    return jsonify({'message': 'Hello API'})

python

This creates a simple API endpoint that returns JSON data.

HTTP Methods in REST APIs

REST APIs use HTTP methods to define actions on resources.

GET    - Retrieve data
POST   - Create data
PUT    - Update data
DELETE - Remove data

text

GET Request Example

@app.route('/api/users', methods=['GET'])
def get_users():
    return jsonify({'users': ['Alice', 'Bob']})

python

POST Request Example

from flask import request

@app.route('/api/users', methods=['POST'])
def create_user():
    data = request.json
    return jsonify({'message': 'User created', 'data': data})

python

Request and Response in Flask APIs

The request object contains incoming data from the client.

The response is usually returned in JSON format for APIs.

JSON in APIs

JSON (JavaScript Object Notation) is the standard format for exchanging data in REST APIs.

{
  "id": 1,
  "name": "John",
  "role": "user"
}

json

URL Parameters in APIs

URL parameters are used to access specific resources.

@app.route('/api/user/<int:id>')
def get_user(id):
    return jsonify({'user_id': id})

python

Query Parameters

Query parameters are used for filtering or searching data.

@app.route('/api/search')
def search():
    query = request.args.get('q')
    return jsonify({'query': query})

python

Status Codes in APIs

HTTP status codes indicate the result of an API request.

200 - Success
201 - Created
400 - Bad Request
404 - Not Found
500 - Server Error

text

Error Handling in APIs

Proper error handling ensures APIs return meaningful messages when something goes wrong.

@app.errorhandler(404)
def not_found(error):
    return jsonify({'error': 'Not Found'}), 404

python

Structuring Flask APIs

Large Flask applications should be structured using Blueprints.

This helps organize routes into modular components.

from flask import Blueprint

api_bp = Blueprint('api', __name__)

@api_bp.route('/status')
def status():
    return jsonify({'status': 'ok'})

python

Authentication in APIs

Most real-world APIs require authentication using tokens or API keys.

Flask can integrate with JWT or OAuth for secure APIs.

Best Practices

Always return consistent JSON responses in APIs.

Use proper HTTP methods and status codes for clarity.

Common Beginner Mistakes

Beginners often return plain text instead of JSON in APIs.

Another mistake is not handling errors properly.

Real-World Importance

Flask REST APIs are widely used in mobile apps, web apps, and microservices.

They form the backbone of modern backend systems.

Summary

Flask makes it easy to build REST APIs using simple routing and JSON responses.

Understanding REST APIs is essential for modern backend development.