Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k4black/fastapi-jwt
FastAPI native extension, easy and simple JWT auth
https://github.com/k4black/fastapi-jwt
api authorization fastapi fastapi-extension json-web-token jwt python python3
Last synced: about 14 hours ago
JSON representation
FastAPI native extension, easy and simple JWT auth
- Host: GitHub
- URL: https://github.com/k4black/fastapi-jwt
- Owner: k4black
- License: mit
- Created: 2021-12-02T14:10:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T10:13:59.000Z (about 2 months ago)
- Last Synced: 2024-09-21T15:03:58.401Z (5 days ago)
- Topics: api, authorization, fastapi, fastapi-extension, json-web-token, jwt, python, python3
- Language: Python
- Homepage: https://k4black.github.io/fastapi-jwt/
- Size: 1.2 MB
- Stars: 123
- Watchers: 1
- Forks: 16
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# fastapi-jwt
[](https://github.com/k4black/fastapi-jwt/actions/workflows/test.yml)
[](https://github.com/k4black/fastapi-jwt/actions/workflows/publish.yml)
[](https://codecov.io/gh/k4black/fastapi-jwt)
[](https://pypi.org/project/fastapi-jwt/)
FastAPI native extension, easy and simple JWT auth
---
**Documentation:** [k4black.github.io/fastapi-jwt](https://k4black.github.io/fastapi-jwt/)
**Source Code:** [github.com/k4black/fastapi-jwt](https://github.com/k4black/fastapi-jwt/)
## Features
* OpenAPI schema generation
* Native integration with FastAPI
* Access/Refresh JWT
* JTI
* Cookie setting
## Installation
You can access package [fastapi-jwt in pypi](https://pypi.org/project/fastapi-jwt/)
```shell
pip install fastapi-jwt[authlib]
# or
pip install fastapi-jwt[python_jose]
```
The fastapi-jwt will choose the backend automatically if library is installed with the following priority:
1. authlib
2. python_jose (deprecated)
## Usage
This library made in fastapi style, so it can be used as standard security features
```python
from fastapi import FastAPI, Security, Response
from fastapi_jwt import JwtAuthorizationCredentials, JwtAccessBearer
app = FastAPI()
access_security = JwtAccessBearer(secret_key="secret_key", auto_error=True)
@app.post("/auth")
def auth():
subject = {"username": "username", "role": "user"}
return {"access_token": access_security.create_access_token(subject=subject)}
@app.post("/auth_cookie")
def auth(response: Response):
subject = {"username": "username", "role": "user"}
access_token = access_security.create_access_token(subject=subject)
access_security.set_access_cookie(response, access_token)
return {"access_token": access_token}
@app.get("/users/me")
def read_current_user(
credentials: JwtAuthorizationCredentials = Security(access_security),
):
return {"username": credentials["username"], "role": credentials["role"]}
```
For more examples see usage docs
## Alternatives
* FastAPI docs suggest [writing it manually](https://fastapi.tiangolo.com/tutorial/security/oauth2-jwt/), but
* code duplication
* opportunity for bugs
* There is nice [fastapi-jwt-auth](https://github.com/IndominusByte/fastapi-jwt-auth/), but
* poorly supported
* not "FastAPI-style" (not native functions parameters)
## FastAPI Integration
There it is open and maintained [Pull Request #3305](https://github.com/tiangolo/fastapi/pull/3305) to the `fastapi` repo. Currently, not considered.
## Requirements
* `fastapi`
* `authlib` or `python-jose[cryptography]` (deprecated)
## License
This project is licensed under the terms of the MIT license.