Saratoga Documentation

Saratoga is a framework for easily creating APIs. It uses Python and Twisted, and supports both CPython 2.7 and PyPy.

Saratoga revolves around versions – it is designed so that you can write code for new versions of your API without disturbing old ones. You simply expand the scope of the unchanged methods, and copy a reference into your new version. It also has helpers for I/O validation and authentication.

You can get the MIT-licensed code on GitHub, or download it from PyPI, with:

$ pip install saratoga

Introduction

A look at Saratoga, starting from the ground up.

• Introduction – Getting Off The Ground
  • Installing
  • A Very Simple Example
  • Going Further
• Introduction - Adding Global State with Service Classes
  • A Basic Service Class
  • Going Further
• Introduction – Authentication
  • Using a Shared Secret Source
  • Why Canonical Usernames?
  • Implementing Your Own Shared Secret Source

Specifications

This specifies the Saratoga API definition format.

• Saratoga API Description
  • Metadata
  • Endpoints
  • Processors
  • Example