https://github.com/xvrdm/flask_restplus_boilerplate
https://github.com/xvrdm/flask_restplus_boilerplate
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/xvrdm/flask_restplus_boilerplate
- Owner: xvrdm
- Created: 2017-03-24T11:43:18.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-24T11:44:00.000Z (about 8 years ago)
- Last Synced: 2024-08-13T07:09:32.359Z (8 months ago)
- Language: Python
- Size: 1000 Bytes
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - xvrdm/flask_restplus_boilerplate - (Python)
README
# Basic Flask_Restplus API boilerplate
## Before you run the app
Install the pip requirements.
```bash
pip install -r requirements.txt
```
## How to run
The app is based on the [application factory
pattern](http://flask.pocoo.org/docs/0.12/patterns/appfactories/).
Make sure you export the `FLASK_APP` env var to the `run.py` script and use
`flask run`.
```bash
# from the app dir
export FLASK_APP=run.py
python -m flask run
```
## How to see Swagger doc
As said on [flask-restplus
documentation](http://flask-restplus.readthedocs.io/en/stable/swagger.html),
> By default flask-restplus provides Swagger UI documentation, served from the root URL of the API.
So just visit `127.0.0.1:5000/api/v1`.