Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DeanWay/fastapi-versioning
api versioning for fastapi web applications
https://github.com/DeanWay/fastapi-versioning
Last synced: 13 days ago
JSON representation
api versioning for fastapi web applications
- Host: GitHub
- URL: https://github.com/DeanWay/fastapi-versioning
- Owner: DeanWay
- License: mit
- Created: 2019-12-02T23:40:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-25T14:20:52.000Z (over 1 year ago)
- Last Synced: 2024-10-01T21:48:25.321Z (about 1 month ago)
- Language: Python
- Size: 74.2 KB
- Stars: 646
- Watchers: 7
- Forks: 63
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fastapi - FastAPI Versioning - API versioning. (Third-Party Extensions / Developer Tools)
- awesome-fastapi - FastAPI Versioning - API versioning. (Third-Party Extensions / Developer Tools)
README
# fastapi-versioning
api versioning for fastapi web applications
# Installation
`pip install fastapi-versioning`
## Examples
```python
from fastapi import FastAPI
from fastapi_versioning import VersionedFastAPI, version
app = FastAPI(title="My App")
@app.get("/greet")
@version(1, 0)
def greet_with_hello():
return "Hello"
@app.get("/greet")
@version(1, 1)
def greet_with_hi():
return "Hi"
app = VersionedFastAPI(app)
```
this will generate two endpoints:
```
/v1_0/greet
/v1_1/greet
```
as well as:
```
/docs
/v1_0/docs
/v1_1/docs
/v1_0/openapi.json
/v1_1/openapi.json
```
There's also the possibility of adding a set of additional endpoints that
redirect the most recent API version. To do that make the argument
`enable_latest` true:
```python
app = VersionedFastAPI(app, enable_latest=True)
```
this will generate the following additional endpoints:
```
/latest/greet
/latest/docs
/latest/openapi.json
```
In this example, `/latest` endpoints will reflect the same data as `/v1.1`.
Try it out:
```sh
pip install pipenv
pipenv install --dev
pipenv run uvicorn example.annotation.app:app
# pipenv run uvicorn example.folder_name.app:app
```
## Usage without minor version
```python
from fastapi import FastAPI
from fastapi_versioning import VersionedFastAPI, version
app = FastAPI(title='My App')
@app.get('/greet')
@version(1)
def greet():
return 'Hello'
@app.get('/greet')
@version(2)
def greet():
return 'Hi'
app = VersionedFastAPI(app,
version_format='{major}',
prefix_format='/v{major}')
```
this will generate two endpoints:
```
/v1/greet
/v2/greet
```
as well as:
```
/docs
/v1/docs
/v2/docs
/v1/openapi.json
/v2/openapi.json
```
## Extra FastAPI constructor arguments
It's important to note that only the `title` from the original FastAPI will be
provided to the VersionedAPI app. If you have any middleware, event handlers
etc these arguments will also need to be provided to the VersionedAPI function
call, as in the example below
```python
from fastapi import FastAPI, Request
from fastapi_versioning import VersionedFastAPI, version
from starlette.middleware import Middleware
from starlette.middleware.sessions import SessionMiddleware
app = FastAPI(
title='My App',
description='Greet uses with a nice message',
middleware=[
Middleware(SessionMiddleware, secret_key='mysecretkey')
]
)
@app.get('/greet')
@version(1)
def greet(request: Request):
request.session['last_version_used'] = 1
return 'Hello'
@app.get('/greet')
@version(2)
def greet(request: Request):
request.session['last_version_used'] = 2
return 'Hi'
@app.get('/version')
def last_version(request: Request):
return f'Your last greeting was sent from version {request.session["last_version_used"]}'
app = VersionedFastAPI(app,
version_format='{major}',
prefix_format='/v{major}',
description='Greet users with a nice message',
middleware=[
Middleware(SessionMiddleware, secret_key='mysecretkey')
]
)
```