django-restlayer 0.9.0

Response class

All your responses should inherit restlayer.Response class. Then, add methods named response_VERB where VERB is an HTTP verb. To handle GET responses, you need to create a response_get method, for POST, response_post. Each response_VERB method acts as a view with needed arguments. A basic example:

from restlayer import Response

class SimpleResponse(Response):
    def response_get(self, request, my_id):
        # This method will match a URL pattern with "my_id"
        return "foo"

class SimpleResponse(Response):
    serializers = Response.serializers + (
      ('text/plain', lambda x: return str(x))
    )

Resource

Your response class should be wrapped within a restlayer.Resource class. The resulting instance is a callable acting like a classic view. You can extend this class to create your own resource. Simply override __call__ method.

from restlayer import Resource

class SillyResource(Resource):
    def __call__(self, request, *args, **kwargs):
        rsp = super(SillyResource, self).__call__(request, *args, **kwargs)
        rsp.status_code = 401
        rsp['Content-Type'] = 'text/plain'
        return rsp

Responses for Django models

If you are working with Django models, you can use restlayer.ModelResponse. Using this parent class for your responses, you can return model instance or queryset. Here is a simple example:

from django.contrib.auth.models import User
from restlayer import ModelResponse

class SimpleResponse(ModelResponse):
    fields = ('id', 'name', 'firstname', 'email')

    def response_get(self, request):
        return User.objects.all()

That’s it! Using the fields property, you set the fields you want to return in the response.

You can add custom methods to create a specific response field. This method takes two parameters: ìnstance and request. Example:

from django.contrib.auth.models import User
from restlayer import ModelResponse

class SimpleResponse(ModelResponse):
    fields = ('id', 'name', 'firstname', 'email', 'other_field')

    def other_field(self, instance, request):
        return instance.name.capitalize()

    def response_get(self, request):
        return User.objects.all()

URLs

You’ll often need to create a resource_uri field to point to another resource in your API. Response class provides two methods to create absolute (with FQDN) URLs:

• _build_absolute_uri(self, request, [location]) only calling request.build_absolute_uri(location) but you can override it if you need.

• reverse(self, request, view, [args, kwargs]) acts as django.core.urlresolvers.reverse but returns an absolute URL.

Pagination

You might want to paginate your responses. Restlayer Response class provides a simple method for this task: paginate(self, request, object_list, [limit]) which is a simple wrapper around django.core.paginator.Paginator. Resulting response will contain the following headers:

• X-Pages-Objects

• X-Pages-Count

• X-Pages-Current

• X-Pages-Next (if next page exists)

• X-Pages-Next-URI (if next page exists)

• X-Pages-Prev (if previous page exists)

• X-Pages-Prev-URI (if previous page exists)