Metadata-Version: 1.1
Name: django-rest-api
Version: 0.1.1
Summary: Django REST API
Home-page: https://github.com/skies-io/django-rest-api
Author: Skies
Author-email: aurelien.maigret@skies.io
License: MIT
Description: Django REST API

        ===============

        

        Installation

        ------------

        

        .. code:: bash

        

            $ pip install django-rest-api

        

        You must use Django 1.7 or higher.

        

        Documentation

        -------------

        

        To begin with, you should read how to create your different API routes: `URL Routing <https://github.com/skies-io/django-rest-api/wiki/URL-Routing>`_.

        

        Then, you need to learn how to return your responses using our format: `Responses format <https://github.com/skies-io/django-rest-api/wiki/Responses-format>`_.

        

        Finally, it could be useful to know why it is advisable to return the results in JSON: `Format results server side <https://github.com/skies-io/django-rest-api/wiki/Format-results-server-side>`_.

        You could also custom the format results on the client side: `Format results client side <https://github.com/skies-io/django-rest-api/wiki/Format-results-client-side>`_.

        

        Two other helpful pages:

        

        - `Get Data <https://github.com/skies-io/django-rest-api/wiki/Get-Data>`_: to retrieve data from the request.

        - `Auth Session <https://github.com/skies-io/django-rest-api/wiki/Auth-Session>`_: to add an authentication system to your API.

        

        Example

        -------

        

        You can see an example which use all functionalities of the plugin `here <https://github.com/skies-io/django-rest-api/tree/master/example>`_.

        
Keywords: django rest api
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
