================ Django Oscar API

This package provides a RESTful API for django-oscar_.

.. _django-oscar: https://github.com/django-oscar/django-oscar

.. image:: https://travis-ci.org/django-oscar/django-oscar-api.svg?branch=master :target: https://travis-ci.org/django-oscar/django-oscar-api

.. image:: https://codecov.io/github/django-oscar/django-oscar-api/coverage.svg?branch=master :alt: Coverage :target: http://codecov.io/github/django-oscar/django-oscar-api?branch=master

.. image:: https://readthedocs.org/projects/django-oscar-api/badge/ :alt: Documentation Status :target: https://django-oscar-api.readthedocs.io/

.. image:: https://badge.fury.io/py/django-oscar-api.svg :alt: Latest PyPi release :target: https://pypi.python.org/pypi/django-oscar-api

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

   .. code-block:: python

   INSTALLED_APPS = [
    ...
    'rest_framework',
    'oscarapi',
   ]
   

3. Add the application's urls to your urlconf

   .. code-block:: python

   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.

.. _Documentation: https://django-oscar-api.readthedocs.io .. _Changelog: https://django-oscar-api.readthedocs.io/en/latest/changelog.html