falcon-jsonify

Falcon middleware to serialize/deserialize JSON. (Python 3 and 2)

$ pip install falcon-jsonify

Add middleware to your app:

import falcon_jsonify

api = falcon.API(middleware=[
    falcon_jsonify.Middleware(help_messages=True),
])

To disable error messages set help_messages=False.

Getting Started

See example usage.

Responses

resp.json = {"my_field": "Hello World"}

Requests

value = req.get_json('my_field')  # required field

• Raises response 400 Bad Request if field does not exist in the request body (JSON).
• Full deserialized dict can be accesed at req.json (without validations), e.g. req.json['my_field'].

Built-in validators

• dtype, min, max

req.get_json('name', dtype=str, min=1, max=16)  # min/max char length
req.get_json('age', dtype=int, min=18, max=99)  # min/max numeric value
req.get_json('amount', dtype=float, min=0.0)
req.get_json('approved', dtype=bool)

• Raises response 400 Bad Request with error message if any validation fails.

Additional parameters

• default, match (regex)

# make a field optional with default value
req.get_json('country_code', dtype=str, default="USA", max=3, min=3)

# custom validation with Regular Expressions
req.get_json('email', match="[^@]+@[^@]+\.[^@]+")

Error responses

Status code: 400 Bad Request

{
  "title": "Validation error",
  "description": "Minimum value for 'age' is '18'"
}