Skip to content

django-oscar/django-oscar-api

Repository files navigation

Django Oscar API

This package provides a RESTful API for django-oscar.

https://travis-ci.org/django-oscar/django-oscar-api.svg?branch=master Coverage Documentation Status Latest PyPi release

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 rest_framework and oscarapi to INSTALLED_APPS

    INSTALLED_APPS = [
     ...
     'rest_framework',
     'oscarapi',
    ]
  3. Add the application's urls to your urlconf

    from django.urls import include
    
    urlpatterns = (
        # all the things you already have
        path("api/", include("oscarapi.urls")),
    )
  4. Apply migrations:

    python manage.py migrate
    

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