/bookapi-swaggdoc

swagger documentation for a flask API

Primary LanguagePython

bookapi-swaggdoc

swagger documentation for a flask API

Setup

  1. Clone repo
  2. create and change into directory
  3. Set Flask environment (ps: check the config.py file)
  • FLASK_ENV=default uses sqlite
  • FLASK_ENV=postgres uses postgres db
  1. set virtualenv with pipenv --three
  2. 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