Install & Compatibility
Where this runs
tested against v0.10.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 1.338s · 31.9MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 3.7s · import 1.214s · 32MB
30MB installed
● package 30MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
VersionedFastAPI
✓ from fastapi_versioning import VersionedFastAPI
✗ from fastapi_versioning.versioned_fastapi import VersionedFastAPI
Old import path no longer works.
version
✓ from fastapi_versioning import version
Direct import from top-level package.
Minimal example using decorator-based versioning with URL prefix.
from fastapi import FastAPI
from fastapi_versioning import VersionedFastAPI, version
app = FastAPI()
@version(1, 0)
@app.get("/")
def read_root():
return {"Hello": "v1"}
app = VersionedFastAPI(app, version_format="{major}.{minor}", prefix_format="/v{major}.{minor}")
Errors
Common errors & fixes
ImportError: cannot import name 'VersionedFastAPI' from 'fastapi_versioning'
Using an old import path (e.g., from fastapi_versioning.versioned_fastapi import VersionedFastAPI).
fixUse: from fastapi_versioning import VersionedFastAPI
AssertionError: Versioning scheme not supported
Using an unsupported versioning scheme or misconfigured parameters.
fixSet versioning_scheme to one of 'header', 'hostname', 'url', 'query'.
Upgrade
Version history
0.10.0latest on PyPI · released Aug 24, 2021
Audit
Dependencies
fastapirequiredCore dependency for API versioning.