Flask API Server - Open-Source API Server | AppSeed
OTHER License
Simple Flask API Boilerplate enhanced with JWT
authentication, OAuth
via GitHub, SqlAlchemy
, SQLite persistence, and deployment scripts via Docker. It has all the ready-to-use
bare minimum essentials.
StartUPs
, Small Businesses
, and Solo-developers
Features:
Up-to-date dependencies
Flask-restX
JWT Authentication
(login, logout, register) via Flask-jwt_extended
OAuth
for Github
Unitary tests
Can be used with other React Starters for a complete Full-Stack experience:
React Node JS Berry | React Node Soft Dashboard | React Node Horizon |
---|---|---|
Docker
Get the code
$ git clone https://github.com/app-generator/api-server-flask.git
$ cd api-server-flask
Start the app in Docker
$ docker-compose up --build
The API server will start using the PORT 5000
.
Step #1 - Clone the project
$ git clone https://github.com/app-generator/api-server-flask.git
$ cd api-server-flask
Step #2 - create virtual environment using python3 and activate it (keep it outside our project directory)
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
Step #3 - Install dependencies in virtualenv
$ pip install -r requirements.txt
Step #4 - setup
flask
command for our app
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
For Windows-based systems
$ (Windows CMD) set FLASK_APP=run.py
$ (Windows CMD) set FLASK_ENV=development
$
$ (Powershell) $env:FLASK_APP = ".\run.py"
$ (Powershell) $env:FLASK_ENV = "development"
Step #5 - Create a new
.env
file using sampleenv.sample
The meaning of each variable can be found below:
DEBUG
: if True
the app runs in develoment mode
False
should be usedSECRET_KEY
: used in assets managementGITHUB_CLIENT_ID
: For GitHub social loginGITHUB_SECRET_KEY
: For GitHub social loginStep #6 - start test APIs server at
localhost:5000
$ flask run
Use the API via POSTMAN
or Swagger Dashboard.
api-server-flask/
├── api
│  ├── config.py
│  ├── __init__.py
│  ├── models.py
│  └── routes.py
├── Dockerfile
├── README.md
├── requirements.txt
├── run.py
└── tests.py
For a fast set up, use this POSTMAN
file: api_sample
Register -
api/users/register
(POST request)
POST api/users/register
Content-Type: application/json
{
"username":"test",
"password":"pass",
"email":"[email protected]"
}
Login -
api/users/login
(POST request)
POST /api/users/login
Content-Type: application/json
{
"password":"pass",
"email":"[email protected]"
}
Logout -
api/users/logout
(POST request)
POST api/users/logout
Content-Type: application/json
authorization: JWT_TOKEN (returned by Login request)
{
"token":"JWT_TOKEN"
}
Run tests using pytest tests.py
Flask API Server - provided by AppSeed