Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaooliveirapro/app-flask-api
Boilerplate Auth and User Registration Flask API
https://github.com/joaooliveirapro/app-flask-api
Last synced: 21 days ago
JSON representation
Boilerplate Auth and User Registration Flask API
- Host: GitHub
- URL: https://github.com/joaooliveirapro/app-flask-api
- Owner: joaooliveirapro
- License: mit
- Created: 2019-09-14T12:14:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-14T21:49:31.000Z (over 5 years ago)
- Last Synced: 2024-11-11T14:45:08.898Z (3 months ago)
- Language: Python
- Homepage:
- Size: 114 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Boilerplate Auth and User Registration Flask API
This project contains a boilerplate backend Authentication module with Login, Logout and Refresh session capabilities base on JWT technology. For the JWT this project uses [PyJWT](https://pyjwt.readthedocs.io/en/latest/).
It has been implemented using [Flask-RESTful](https://flask-restful.readthedocs.io/en/latest/) and has been rigourously tested using [pytest](https://docs.pytest.org/en/latest/).
This project also uses [marshmallow](https://marshmallow.readthedocs.io/en/stable/) as a Schema serializer to easily provide JSON-formatted output for all API endpoints. Data models use [Flask-SQLAlchemy](https://flask-sqlalchemy.palletsprojects.com/en/2.x/) as the [ORM](https://en.wikipedia.org/wiki/Object-relational_mapping). A [custom decorator](https://github.com/j-000/ezresbackend/blob/master/decorators.py) has been added to protect API routes that require authentication.
This project can be further customisable to attend to your individual project needs. It can be used in conjuction with any frontend framework like [Vue.js](https://vuejs.org/) to create full-stack applications.
## Clone and run tests
Clone the repo, create a virtual environment and activate it. Install the dependencies necessary and run the tests.
```
git clone [email protected]:j-000/ezresbackend.git
cd ezresbackend
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
pytest -v
```
:warning: Make sure you change the applicationsecrets.py details, expecially the `SECRET_KEY` and `SECURITY_PASSWORD_SALT` :warning:
## Try it
Current API routes are:
Register a user.
```
POST /api/user
payload={'email':'[email protected]', 'name':'Joao', 'password':'test123'}
# response
{
"message": "User created.",
"success": true,
"user": {
"email": "[email protected]",
"id": 1,
"is_admin": false,
"name": "Joao"
}
}
```
Get total users registered.
```
GET /api/user
# response
{
"usersRegistered": 1
}
```
Login.
```
POST /api/auth
headers = {'content-type':'application/json'}
payload = {'email':'[email protected]', 'password':'test123'}
# response
{
"expires": 3600,
"success": true,
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1Ni...AC8z71WOuvMToh2IbqdqHDAX_mcJSnlWevKONqAJp4"
}
```
Refresh Token.
```
PUT /api/auth
headers = {'Authorization':f'Bearer {token}'}
# response
{
"success": "New token.",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1...hZ4ptK5KdrdgqMLK-cx11f-Qc_E-yw-8WuNggvOF13rwg"
}
```
Logout.
```
DELETE /api/auth
headers = {'Authorization':f'Bearer {token}'}
# response
{
"success": "Logged out."
}
```
Licence MIT