Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.03 KB

README.rst

File metadata and controls

55 lines (42 loc) · 2.03 KB

Build Status PyPI version Coverage Status Stories in Ready

Tornado-JSON is a small extension of Tornado with the intent providing the tools necessary to get a JSON API up and running quickly. See demos/helloworld/ for a quick example and the accompanying walkthrough in the documentation.

Some of the key features the included modules provide:

  • Input and output JSON Schema validation by decorating RequestHandlers
  • Automated route generation with routes.get_routes(package)
  • Automated Public API documentation using schemas and provided descriptions
  • Standardized output using the JSend specification

Warning: Tornado-JSON is still very much a work in progress. No guarantees on backwards-compatibility made, however, I try not to do that since, as a user, I hate breaking it at least as much as you. That being said, use it at your own risk.

These dependencies can be satisfied by running pip install -r requirements.txt

  • tornado
  • jsonschema