README.rst

Django Oscar API

This package provides a RESTful API for django-oscar.

Usage

To use the Oscar API application in an Oscar E-commerce site, follow these steps:

1. Install the django-oscar-api package (pip install django-oscar-api).

2. Add oscarapi to INSTALLED_APPS.

3. Add the application's urls to your urlconf

   from django.conf.urls import url
   
   from oscarapi.app import application as api
   
   urlpatterns = (
       # all the things you already have
       url(r'^oscarapi/', api.urls),
   )

   or with the newer Django 2.x way

   from django.urls import path
   
   from oscarapi.app import application as api
   
   urlpatterns = (
       # all the things you already have
       path('oscarapi/', api.urls),
   )

4. Apply migrations:

   python manage.py migrate
   

See the Documentation for more information and the Changelog for release notes.