Home

Awesome

Django Jsend Responses

Jsend specified Responses for APIs.


Overview

Django Jsend Responses supply response classes to use in projects created with Django. See http://labs.omniti.com/labs/jsend for jsend spec.


Requirements

Installation

Install using pip...

pip install djangojsendresponses

Using in a code

from jsend_responses import SuccessResponse
from rest_framework.views import APIView


class DriverAPIView(APIView):
    def get(self):
        driver = get_random_driver()
        return SuccessResponse(object=driver)

Response examples

Success response:

{
    "status": "success",
    "data": {
        "object": { 
            "id": 1, 
            "name": "Fist object"
        }
    }
}

Fail response:

{
    "status" : "fail",
    "data" : {
        "name" : "A name is required" 
    }
}

Error response:

{
    "status" : "error",
    "message" : "A service is unavailable to connect"
}