https://github.com/obaraelijah/rest_api_flask
Building a REST API with Flask
https://github.com/obaraelijah/rest_api_flask
flask-api flask-sqlalchemy jwt python3
Last synced: over 1 year ago
JSON representation
Building a REST API with Flask
- Host: GitHub
- URL: https://github.com/obaraelijah/rest_api_flask
- Owner: obaraelijah
- Created: 2023-02-04T19:46:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-07T11:24:03.000Z (over 3 years ago)
- Last Synced: 2025-01-30T12:26:40.883Z (over 1 year ago)
- Topics: flask-api, flask-sqlalchemy, jwt, python3
- Language: Python
- Homepage:
- Size: 16.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Building A REST API with Flask
A pizza delivery API Built with Flask
## Topics Learned
- How to set up a Flask API with Flask-RESTX
- Databases with FlaskJWT Authentication with Flask-JWT-Extended-SQLAlchemy
- Environment variables with Python-Decouple
- Database migrations with Flask-Migrate
- How to write Unit Tests with Unittest and PyTest
- Documenting REST APIs with SwaggerUI and Flask-RESTX
- Error Handling with Werkzeug
## How to run the project
Clone the project Repository
```$ https://github.com/obaraelijah/REST_API_FLASK.git```
Enter the project folder and create a virtual environment
```$ cd Enter the project folder and create a virtual environment ```
``$ python -m venv env ``
Activate the virtual environment
```
$ source env/bin/actvate #On linux Or Unix
$ source env/Scripts/activate #On Windows
```
### Install all requirements
``` $ pip install -r requirements.txt```
### Run the project in development
```
$ export FLASK_APP=api/
$ export FLASK_DEBUG=1
$ flask run
```
#### OR
```
python runserver.py
```