req

Release v2.2.0.

Req helps you define the kinds of data your REST APIs deal with. With those definitions in place you can validate incoming requests, convert between internal and external data representations, output JSON Schema and Swagger specs for your API, automatically generate Python clients and more.

Organization

Req documentation is split into three parts:

• A tutorial that introduces the basic concepts of req and takes you from scratch all the way through building a simple API.
• A number of guides that dive deeper into the various concepts present in req. In addition to explaining the aforementioned concepts, these guides include recipes that explain the steps involved in solving common problems using req.
• The Python API reference documentation.

Assumptions

Since req currently integrates best with Falcon, these docs assume you are at least minimally familiar with the basics of that framework. If you aren’t, start with their docs first.

The Tutorial

Start here if you’re completely new to req. The tutorial will take you through building a simple Falcon/req API from scratch.

• The Tutorial
  • Installation
  • Goals of the Tutorial
  • Structure Your Project
  • Core Concepts
  • A Schema for Articles
  • Your First Endpoints
  • Looking Up Individual Articles
  • Lists of Articles
  • Next Steps

The User Guides

• The User Guides
  • Schema
  • Endpoints
  • Decorators

The API Reference

• The API Reference
  • Endpoints
    • Adapters
  • Schema
    • Properties
    • Exceptions
    • Adapters
  • Falcon Integration
    • Decorators
  • Webapp2 Integration
    • Decorators
  • Wask Integration
    • Decorators

Reporting problems

If you spot any typos, missing words, invalid code samples or stuff that’s plain wrong, feel free to open an issue on the req issue tracker or to open a pull request containing a fix.