bookapi-swaggdoc
swagger documentation for a flask API
Setup
- Clone repo
- create and change into directory
- Set Flask environment (ps: check the
config.py
file)
FLASK_ENV=default
uses sqliteFLASK_ENV=postgres
uses postgres db
- set virtualenv with
pipenv --three
- Install with
pipenv install
Running
Deployed documentation version: https://waweru.pythonanywhere.com/api-docs/
local setup
- type:
python run.py
serving point of the API - app running on
http://127.0.0.1:5000/
- Documentation being served on
/api-docs
endpoint