Permalink
Find file Copy path
76a02ba Dec 13, 2018
3 contributors

Users who have contributed to this file

@maerteijn @ehmadzubair @carxwol
108 lines (69 sloc) 3.12 KB

Django Oscar API

This package provides a RESTful API for django-oscar, it's based on django-rest-framework and it exposes most of Oscar's functionality. You can find the source code on GitHub. If you have any questions or problems using Oscar API, please use the Github issuetracker.

Requirements:

This version of Oscar API is compatbile with python 2.7 / 3.5 / 3.6 / 3.7 and the following django versions:

Django 1.11:

  • Oscar 1.5.3 / 1.6.x
  • requires djangorestframework>=3.4

Django 2.0 and 2.1:

  • Oscar 1.6.x
  • requires djangorestframework>=3.7
  • requires python >=3.5

See Travis for the current tested platforms.

Installation

Please see the installation instructions of Oscar to install Oscar and how to create your own project. Then you can install Oscar API by simply typing:

$ pip install django-oscar-api

Or you could add django-oscar-api to your project dependencies.

Note

If you would like to install the current development version, use this:

$ pip install git+https://github.com/django-oscar/django-oscar-api.git

Use out-of-the-box

You can use the oscarapi application in an oscar ecommerce site without any customization. See for more information: :doc:`/usage/outofthebox`

Play around with the sandbox

You can also install Oscar API from source and run the sandbox site to play around a bit. Make sure to create a virtualenv first.

$ mkvirtualenv oscarapi
$ git clone https://github.com/django-oscar/django-oscar-api.git
$ cd django-oscar-api
$ make sandbox

# run the server
$ python sandbox/manage.py runserver

Now you can browse the API at http://localhost:8000/api. Here you can actually use the API already (a cool feature of django-rest-framework) by using your browser and test which JSON formats you can send/receive.

But I want to customise the standard serializers / views!

Probably you want this, because you already extended or changed Oscar's functionality by forking it's apps right? See :doc:`/usage/customizing_oscarapi` for this.

.. toctree::
   :hidden:
   :maxdepth: 1

   usage/outofthebox
   usage/communicate_with_the_api
   usage/middleware
   usage/settings
   usage/permissions
   usage/signals
   usage/customizing_oscarapi
   changelog.rst