FastAPI RESTful

0.6.0 · active · verified Thu Apr 16

FastAPI-RESTful provides helper utilities to streamline FastAPI development, particularly for building RESTful APIs using class-based views (CBV) and resource inferring routers. It aims to reduce boilerplate when defining API endpoints and integrates well with common patterns like SQLAlchemy sessions. The current version is 0.6.0, and it has a moderate release cadence, with minor versions released every few months, often incorporating dependency updates and bug fixes.

Common errors

```
ModuleNotFoundError: No module named 'sqlalchemy'
```
cause Attempting to use SQLAlchemy-related features (e.g., database session management) without installing the `[session]` extra.

fix Install `fastapi-restful` with the session extra: `pip install fastapi-restful[session]`.
```
pydantic.v1.error_wrappers.ValidationError
```
cause This error or similar Pydantic V2 validation errors can occur if you've upgraded `fastapi-restful` to version `0.5.0` or later, but your Pydantic models are still written for Pydantic V1.

fix Migrate your Pydantic models and validation logic to be compatible with Pydantic V2. This often involves changes to how fields are defined, default values, and custom validators.
```
AttributeError: 'Session' object has no attribute 'query'
```
cause This typically indicates that you are attempting to use SQLAlchemy 1.x API methods (like `session.query()`) with SQLAlchemy 2.0, which is mandated by `fastapi-restful` versions `>=0.5.0` when the `[session]` extra is installed.

fix Update your SQLAlchemy code to use the SQLAlchemy 2.0 API, primarily using `select()` constructs with `session.execute()` instead of `session.query()`.
```
ERROR: Package 'fastapi-restful' requires a different Python: ...
```
cause Your current Python version does not meet the minimum requirements of the `fastapi-restful` package (e.g., Python < 3.7).

fix Upgrade your Python environment to version 3.7 or newer to satisfy the package's requirements.

Warnings

breaking Version 0.5.0 introduced compatibility with Pydantic V2 and SQLAlchemy 2.0. If you are upgrading from an older version and use Pydantic or SQLAlchemy, you will likely encounter breaking changes.
Fix: Review and update your Pydantic models and SQLAlchemy query/session patterns to align with Pydantic V2 and SQLAlchemy 2.0 APIs. Consult their respective migration guides.
breaking Support for older Python versions was dropped. Versions 0.4.2 and later require Python 3.6.2+, and the project currently officially supports Python 3.7+.
Fix: Ensure your project environment uses Python 3.7 or a newer compatible version. Older Python versions will result in installation failures or runtime errors.
gotcha Prior to version 0.4.5, `fastapi-restful` used to pin the `FastAPI` dependency more strictly. This could lead to dependency conflicts if your project relied on a different `FastAPI` version.
Fix: Upgrade to `fastapi-restful` version 0.4.5 or newer, which removed the strict FastAPI version locking. This allows for greater flexibility in managing your FastAPI version.
gotcha SQLAlchemy support (e.g., session management) requires installing the `[session]` extra. Without it, you'll encounter `ModuleNotFoundError` if you try to use related features.
Fix: If you intend to use SQLAlchemy integration, install the package with `pip install fastapi-restful[session]`.

Install

pip install fastapi-restful Base installation
pip install fastapi-restful[session] Installation with SQLAlchemy session support

Imports

Resource

from fastapi_restful.resource import Resource

cbv
```
from fastapi_restful.cbv import cbv
```

InferringRouter

from fastapi_restful.inferring_router import InferringRouter

Api
wrong:
```
from fastapi_restful.app import Api
```
correct:
```
from fastapi_restful.api import Api
```
The `Api` class is in `fastapi_restful.api`, not `fastapi_restful.app`.

Quickstart

This quickstart demonstrates how to define a class-based view (CBV) using `fastapi-restful`'s `Resource` and `InferringRouter`. The `cbv` decorator automatically registers methods as API endpoints based on their names (e.g., `get_hello` becomes a GET endpoint at `/hello`).

from fastapi import FastAPI
from fastapi_restful.resource import Resource
from fastapi_restful.cbv import cbv
from fastapi_restful.inferring_router import InferringRouter

app = FastAPI()
router = InferringRouter()

@cbv(router)
class HelloWorldResource(Resource):
    def get_hello(self):
        return {"message": "Hello World from CBV!"}

app.include_router(router)

# To run this:
# 1. Save as main.py
# 2. uvicorn main:app --reload
# 3. Access http://127.0.0.1:8000/hello

view raw JSON →