Skip to main content

Django app for using API Star as frontend.

Project description

This project is a Django App that switches between Django and API Star’s routes and views. That way, we have API Star as the API frontend, while leaving Django’s toolset available for devs to work with.

Both API Star’s docs and Django Admin work as intended.


  • django>=1.8
  • apistar>=0.3.5


pip install django_apistar

After installing, we need to add django_apistar to your INSTALLED_APPS in your project’s


Then, we need two settings set if we want to use apistar: a base route module (APISTAR_ROUTE_CONF) and API Star’s own settings. After you’ve defined the databases in your settings file:


    'ALLOWED_DJANGO_ROUTES': ('/admin/', '/static/'),

APISTAR_ROUTE_CONF = 'your_api_star_app.routes'

The ALLOWED_DJANGO_ROUTES key describes which routes you want API Star to ignore. Only '/static/' is required, since we want Django to keep managing static files for us.

Now, if you want to run the dev server, you can use python run (not runserver) and hack away!

Changing the default live server

By default, Django uses it’s own WSGI server, so running python runserver will result in broken API Star routes. If you really want to use Django’s runserver command, you must overwrite the WSGI_APPLICATION in your with our own WSGI application:

WSGI_APPLICATION = 'django_apistar.wsgi.application'


For now, we only provide a class for Basic authentication.

To use it, configure your APISTAR_SETTINGS as you would configure your API Star app:

from django_apistar.auth import DjangoBasicAuthentication


APISTAR_SETTINGS['AUTHENTICATION'] = [DjangoBasicAuthentication()],

How it works

This Django app contains a custom WSGI application that smartly changes between API Star’s and Django’s response handlers. By default, all requests will be responded by API Star, unless the ALLOWED_DJANGO_ROUTES settings key contains that route.

This way, we are able to bypass Django completely when responding API requests, while keeping Django ready to respond to more complicated requests, like Django Admin and complex template/form views.

Another big advantage is that this app enables both Django Admin and API Star automatic API docs.

Implementing views

There is no need to think about corner cases when writing views. We only need to keep in mind that we won’t be able to use the django_orm backend baked into API Star, so we must access models directly to deal with CRUD operations.

For example, let’s create a view that persists a Product:

from core import schemas
from core import models

def create_product(product: schemas.Product) -> schemas.Product:
    db_product = models.Product(**product)
    return http.Response(content=schemas.Product(db_product.__dict__), status=201)

As intended, all the data validation is at the schemas, and everything is handled gracefully by API Star.

Implementing tests

To test your API Star views, we provide a hybrid TestClient that is API Star aware and a custom TestCase, leveraging Django’s own TestCase by including the reverse_url method from API Star’s router:

from django_apistar.test import TestCase #  our custom TestCase
from model_mommy import mommy

from core import models, schemas

class TestListProducts(TestCase):

    def test_list_products(self):
        The reverse_url method behaves exactly like Django's reverse,
        but uses the view's defined name as namespace.
        The builtin client is based on the API Star Test Client,
        so it's preferred to use this test case only to test API Star's views.

        url = self.reverse_url('list_products')
        db_product = mommy.make(models.Product, rating=5, size='large')

        response = self.client.get(url)
        content = response.json()

        expected_product = schemas.Product(db_product.__dict__)
        self.assertEqual(1, len(content))
        self.assertEqual(expected_product, content[0])


There are still a lot of ways we can improve and add more features to this app. If you find any bugs or have significant suggestions, just open an issue or contact me at Pull requests will be received with all care and attention as well :)



  • removes the middleware implementation in favor of a custom WSGI app;
  • removes templates folder and, since they won’t be necessary anymore;
  • adds custom TestClient and TestCase to the tests module;
  • improves performance by ~100% by bypassing Django when answering API Star’s requests.


  • coupled API Star to Django via middlewares;
  • hijacks Django’s WSGI process to respond using API Star’s views.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-apistar, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size django_apistar-0.3.2-py3-none-any.whl (564.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django_apistar-0.3.2.tar.gz (558.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page