Flask-RESTful

0.3.10 · maintenance · verified Thu Apr 09

Flask-RESTful is an extension for Flask that simplifies the creation of REST APIs by providing building blocks like Resources for organizing endpoints and `reqparse` for input validation. The current stable version is 0.3.10, released in May 2023. While still available, the project appears to be in maintenance mode with infrequent updates and hasn't seen major feature releases since 2014.

Warnings

breaking Flask-RESTful may encounter breaking issues or unexpected behavior with Flask versions 2.3 and newer, specifically due to changes in its underlying `werkzeug` dependency. Some unit tests may fail, indicating potential compatibility problems.
Fix: Consider using an older Flask version (e.g., <2.3) if encountering issues, or explore alternative API frameworks like Flask-RESTX which is built on Flask-RESTful and offers more active maintenance and features. If staying with Flask-RESTful, monitor its GitHub issues for potential patches related to newer Flask versions.
gotcha The `flask-restful` project has seen limited development and maintenance activity since 2014, despite a recent version bump. Users seeking more active development, modern features (like auto-generated documentation via Swagger UI), or better compatibility with the latest Python/Flask ecosystems might find it lacking.
Fix: For new projects or if advanced features and active maintenance are crucial, consider using Flask-RESTX, which is a successor to Flask-RESTful and provides additional capabilities like Swagger documentation and namespaces.
gotcha While Flask-RESTful supports dependency injection by allowing arguments to be passed to resource constructors via `add_resource()`, it does not provide a built-in, sophisticated dependency injection framework.
Fix: Developers may need to implement their own manual dependency injection or integrate a separate dependency injection library if a more robust solution is required. Alternatives like FastAPI offer built-in dependency injection.
gotcha The PyPI classifiers for `flask-restful` still list compatibility with Python 2.7, which is end-of-life and no longer officially supported by the Python community. Developing new applications with Python 2.7 is strongly discouraged.
Fix: Ensure your project runs on Python 3.x. While Flask-RESTful 0.3.10 is compatible with Python 3.x, relying on a library that still officially lists Python 2.7 support might indicate dated design considerations.

Install

pip install flask-restful Install latest version

Imports

Api
```
from flask_restful import Api
```
Main class for Flask-RESTful API initialization.
Resource
```
from flask_restful import Resource
```
Base class for defining API endpoints.
reqparse
```
from flask_restful import reqparse
```
Module for parsing and validating request arguments.

Quickstart

This quickstart demonstrates how to create a simple Flask-RESTful API. It defines two resources: one for a 'Hello, World!' message at the root path and another to calculate the square of an integer at `/square/<num>`. To run, save as `app.py` and execute `python app.py`. Access `http://127.0.0.1:5000/` for the greeting or `http://127.0.0.1:5000/square/5` for the square calculation.

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class HelloWorld(Resource):
    def get(self):
        return {'message': 'Hello, World!'}

class Square(Resource):
    def get(self, num):
        return {'square': num**2}

api.add_resource(HelloWorld, '/')
api.add_resource(Square, '/square/<int:num>')

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

view raw JSON →