Skip to content
This repository has been archived by the owner on May 2, 2023. It is now read-only.

Latest commit

 

History

History
31 lines (19 loc) · 1.25 KB

README.rst

File metadata and controls

31 lines (19 loc) · 1.25 KB

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.