Skip to main content

JSON API should be as simple as `dict` and status code :)

Project description


JSON API should be as simple as dict and status code :)

Hello world

from raw_api import validate_json

@validate_json({"name": str})
def hello(request):
    name = request.json["name"]
    if name == "world":
        return "won't work here", 400
    return {"hello": name}


  • Install in from pypi: pip install django-raw-api
  • Add raw_api.middleware middleware into MIDDLEWARE list of your



It adds lazy request.json attribute and serializes raw responses such as:

  • str or tuple (message: str, status: int) - into plain text response
  • dict or (data: dict, status: int) - into JSON response


  • request.json - parsed json
  • request.query - parsed query (only after @validate_query)


You can just return str, dict with an optional status code

def hello(request):
    return "hi"

def hello_json(request):
    return {"hello": "world"}

def with_status(request):
    return {"message": "bad request"}, 400


Decorators @user_required and @staff_required is analogous to @login_required and @staff_member_required with JSON output instead of redirecting

from raw_api import staff_required

async def hello(request):
    return {"admin": "zone"}

Data validation

@validate_query and @validate_json decorators are there to perform simple first-level validation of requests data. Internally they use the trafaret library.

from raw_api import validate_json, validate_query

@validate_json({"ids": [int], "hello?": str})
async def foo(request):
    return request.json

@validate_query({"id": int})
async def bar(request):
    assert isinstance(id, int)
    return request.query


    python -m venv .venv
    source .venv/bin/activate
    pip install -Ur requirements-dev.txt
    python -m pytest tests

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

django_raw_api-0.3.0-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page