Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://nf1s.github.io/sanic-camelcase-middleware/

Middleware for camelizing request and response bodies for sanic
https://nf1s.github.io/sanic-camelcase-middleware/

middleware mkdocs python python3 python36 sanic sanic-framework sanic-middleware

Last synced: 3 months ago
JSON representation

Middleware for camelizing request and response bodies for sanic

Awesome Lists containing this project

README

        

# Sanic Camelcase Middleware

[![CircleCI](https://circleci.com/gh/nf1s/sanic-camelcase-middleware.svg?style=shield)](https://circleci.com/gh/nf1s/sanic-camelcase-middleware) [![codecov](https://codecov.io/gh/nf1s/sanic-camelcase-middleware/branch/master/graph/badge.svg)](https://codecov.io/gh/nf1s/sanic-camelcase-middleware) [![Downloads](https://pepy.tech/badge/sanic-camelcase-middleware)](https://pepy.tech/project/sanic-camelcase-middleware) ![GitHub Pipenv locked Python version](https://img.shields.io/github/pipenv/locked/python-version/nf1s/sanic-camelcase-middleware) ![GitHub](https://img.shields.io/github/license/nf1s/sanic-camelcase-middleware)

Middleware for camelizing request and response bodies for sanic

Full documentation can be found [here](https://nf1s.github.io/sanic-camelcase-middleware/)

## How to install

```bash
pip install sanic-camelcase-middlware
```

### Example

```python
from sanic import Sanic
from sanic_camelcase_middleware import Camelize

app = Sanic(__name__)
Camelize(app)
```

### Full example

```python
from sanic import Sanic
from sanic.response import json
from sanic_camelcase_middleware import Camelize

app = Sanic(__name__)

Camelize(app)

@app.route("/post", methods=["POST"])
async def test(request):
return json("is_camelcase": True, "message": request.json})

if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
```

### To disable the middleware for request payload

```python
from sanic import Sanic
from sanic_camelcase_middleware import Camelize

app = Sanic(__name__)

# default `decamelize_request=True`
Camelize(app, decamelize_request=False)

```

### To disable the middleware for response body

```python
from sanic import Sanic
from sanic_camelcase_middleware import Camelize

app = Sanic(__name__)

# default `camelize_response=True`
Camelize(app, camelize_response=False)

```