KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #dsh #dsh-plugin #ai-agent #claude-code #codex #typescript #ai-agents #mcp #cli #rust #deepseek-harness

falcon-jsonify

★ 38 Open GitHub ↗

Falcon middleware to serialize/deserialize JSON with built-in request validator

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# falcon-jsonify
 [Falcon](https://github.com/falconry/falcon) middleware to serialize/deserialize JSON. (Python 3 and 2)

```shell
$ pip install falcon-jsonify
```

Add middleware to your app:

```python
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](https://github.com/AndreiRegiani/falcon-mongo-template/blob/master/src/resources/example.py).

### Responses
```python
resp.json = {"my_field": "Hello World"}
```

### Requests
```python
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`

```python
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)

```python
# 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
```javascript
{
  "title": "Validation error",
  "description": "Minimum value for 'age' is '18'"
}
```

falcon-jsonify

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README