Manage Django URLs for AngularJS

AngularJS controllers communicating with the Django application through Ajax, often require URLs, pointing to some of the views of your application. Don’t fall into temptation to hard code such a URL into the client side controller code. Even worse would be to create Javascript dynamically using a template engine. There is a clean and simple solution to solve this problem.

This service is provided by djangoUrl.reverse(name, args_or_kwargs) method. It behaves exactly like Django’s URL template tag.

Basic operation principle

django-angular encodes the parameters passed to djangoUrl.reverse() into a special URL starting with /angular/reverse/.... This URL is used as a new entry point for the real HTTP invocation.



  • Include django-angular.js:
<script src="{% static 'djng/js/django-angular.js' %}"></script>
  • Add djng.urls as a dependency for you app:
    var my_app = angular.module('MyApp', ['djng.urls', /* other dependencies */]);

The djangoUrl service is now available through dependency injection to all directives and controllers.

Setting via Django Middleware

  • Add 'djng.middleware.AngularUrlMiddleware' to MIDDLEWARE_CLASSES in your Django file:
    # Other middlewares


This must be the first middleware included in MIDDLEWARE_CLASSES

Using this approach adds some magicness to your URL routing, because the AngularUrlMiddleware class bypasses the HTTP request from normal URL resolving and calls the corresponding view function directly.


The reversing functionality is provided by:

djangoUrl.reverse(name, args_or_kwargs)

This method behaves exactly like Django’s URL template tag {% url 'named:resource' %}.


  • name: The URL name you wish to reverse, exactly the same as what you would use in {% url %} template tag.
  • args_or_kwargs (optional): An array of arguments, e.g. ['article', 4] or an object of keyword arguments, such as {'type': 'article', 'id': 4}.


A typical Angular Controller would use the service djangoUrl such as:

var myApp = angular.module('MyApp', ['djng.urls']);

myApp.controller('RemoteItemCtrl', function($scope, $http, $log, djangoUrl) {

  var fetchItemURL = djangoUrl.reverse('namespace:fetch-item');

  $http.get(fetchItemURL).success(function(item) {
    $'Fetched item: ' + item);
  }).error(function(msg) {
    console.error('Unable to fetch item. Reason: ' + msg);

and with args:

$http.get(djangoUrl.reverse('api:articles', [1]))

or with kwargs:

$http.get(djangoUrl.reverse('api:articles', {'id': 1}))

Parametrized URLs

You can pass a “parametrized” arg or kwarg to djangoUrl.reverse() call to be used with $resource.

var url = djangoUrl.reverse('orders:order_buyer_detail', {id: ':id'});
// Returns  '/angular/reverse/?djng_url_name=orders%3Aorder_buyer_detail&djng_url_kwarg_id=:id'
// $resource can than replace the ':id' part

var myRes = $resource(url);
myRes.query({id:2}); // Will call reverse('orders:order_buyer_detail', kwargs={'id':2}) url

// If :param isn't set it will be ignored, e.g.
myRes.query(); // Will call reverse('orders:order_buyer_detail') url

// with @param $resource will autofill param if object has 'param' attribute
var CreditCard = $resource(djangoUrl.reverse('card', {id: ':id'}), {id: '@id'});
var card = CreditCard.get({id: 3}, function (success) {
  card.holder = 'John Doe';
  card.$save() // Will correctly POST to reverse('card', kwargs={'id':3})

Additional notes

If you want to override reverse url, e.g. if django app isn’t on top level or you want to call another server it can be set in .config() stage:

myApp.config(function(djangoUrlProvider) {


The path of request you want to reverse must still remain /angular/reverse/ on django server, so that middleware knows it should be reversed.