Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 896 Bytes

README.md

File metadata and controls

34 lines (24 loc) · 896 Bytes

Flask API Starter Kit

Sample API layout structure to be used as a baseline for other apps

Dependencies

  • flask: Python server of choise
  • flasgger: Used to generate the swagger documentation
  • flask-marshmallow: My favourite serializer
  • apispec: Required for the integration between marshmallow and flasgger

Set Up

  1. Check out the code

  2. Install requirements

    pipenv install
    
  3. Start the server with:

    pipenv run python -m flask run
    
  4. Visit http://localhost/api for the home api

  5. Visit http://localhost/apidocs for the swagger documentation

Tests

The code is covered by tests, to run the tests please execute

pipenv run python -m unittest