Skip to main content

Framework providing REST JSON API to Tornado web server

Project description

Tornado_jsonapi

Tornado_jsonapi is a library for creating JSON API (as per jsonapi.org specification) using Tornado web framework. It features

  • semi-automatic API generation using provided JSON schema of resource;
  • support for arbitrary data sources, including SQLAlchemy and PostgreSQL (via DBAPI2 support layer);
  • support for asynchronous data source operations;
  • strict jsonapi.org specification conformance.

Usage

import sqlite3
import tornado.ioloop
import tornado.web
import tornado_jsonapi.handlers
import tornado_jsonapi.resource

schema = {
    "title": "post",
    "properties": {
        "text":
        {
            "type": "string"
        },
        "author":
        {
            "type": "string"
        }
    }
}

res = tornado_jsonapi.resource.DBAPI2Resource(
    schema, sqlite3, sqlite3.connect(':memory:'))
res._create_table()

application = tornado.web.Application([
    (
        r"/api/posts/([^/]*)",
        tornado_jsonapi.handlers.APIHandler,
        dict(resource=res)
    )
])
application.listen(8888)
tornado.ioloop.IOLoop.current().start()

Installation

$ pip install tornado_jsonapi

Roadmap

a.k.a. TODO

  • improve documentation :pensive:
  • automatic API doc generation based on JSON schema;
  • MongoDB/Motor support;
  • support for API testing.

License

This project is licensed under the MIT License.

Changelog

0.1.0 (2016-03-21)

  • First release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tornado-jsonapi, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size tornado_jsonapi-0.1.1.tar.gz (14.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page