Django REST API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
rest_api
.gitignore
LICENSE
NewVersion.md
README.rst
requirements.txt
setup.cfg
setup.py

README.rst

Django REST API

Installation

$ pip install django-rest-api

You must use Django 1.6 or higher.

Documentation

To begin with, you should read how to create your different API routes: URL Routing.

Then, you need to learn how to return your responses using our format: Responses format.

Finally, it could be useful to know why it is advisable to return the results in JSON: Format results server side. You could also custom the format results on the client side: Format results client side.

Two other helpful pages:

  • Get Data: to retrieve data from the request.
  • Auth Session: to add an authentication system to your API.

Example

You can see an example which use all functionalities of the plugin here.