Skip to main content

A collection of routines for building web APIs on top of Tornado web server.

Features

  • Automatic support multiple response formats (JSON, JSONP, XML)

  • Pluggable authentication

  • Error handling

Example usage

import apikit

# Returning objects as response (only basic JSON-encodable types supported):
class MyApiHander(apikit.ApiHandler):
    def get(self):
        self.write_response({'result' : 'sucess',
                             'x' : 1, y : [1,2,3]})

# Authentication:
class MyProtectedResourceBase(apikit.ProtectedResource):
    def authenticate(self, callback):
        if self.get_argument('password') != '12345':
            raise tornado.web.HTTPError(403, "Incorrect or missing password!")
        callback()

class MyProtectedResource(MyProtectedResourceBase):
    def get(self):
        ...

Installation

$ pip install tornado-api-kit

Download files

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

Source Distribution

tornado-api-kit-0.0.1.tar.gz (2.6 kB view details)

Uploaded Source

File details

Details for the file tornado-api-kit-0.0.1.tar.gz.

File metadata

File hashes

Hashes for tornado-api-kit-0.0.1.tar.gz
Algorithm Hash digest
SHA256 c2bc33915da9f1090691ebfe6a704d1b5628afaa8989d1c6235f671c62991334
MD5 4b43c702dd14229fba8f66d946ec1172
BLAKE2b-256 8e00e785b8afe7b9ec6c829e469cf1f8a316f383580fdc5e062ebba6286b9448

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.0.1 This release

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page