Wiki

Clone wiki

rest-api-blueprint / CodeLayout

See https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/:

Debugging:

  • runserver.py - invoke debugging Flask server

Main:

  • restapiblueprint/blueprints/*.py - the Flask blueprints
  • restapiblueprint/views.py - hook blueprints to base URLs
  • restapiblueprint/lib/*.py - utility functions
  • restapiblueprint/templates/ - directory of Flask templates (currently only one taken from HTML5 Boilerplate, used to display HTTP errors)
  • restapiblueprint/static/ for serving up by Flask in the standard way

Testing:

  • restapiblueprint/features/ - standard behave directory of gherkin tests and steps

Documentation:

  • restapiblueprint/apidocs/ - directory of Sphinx source reST docs for the API
  • make_apidocs.sh - simple bash scipt to convert source apidocs into html in the static directory

Updated