Django DRF: Default URL always gets trigered first instead of route.url

Question

I have a very simple Django Rest Framework application, my urls.py looks like the following

router = routers.DefaultRouter()
router.register(r'activity-list', activities.views.ArticleViewSet)

urlpatterns = [

    url(r'^admin/', admin.site.urls),

    url(r'^api/', include(router.urls, namespace='api')),

] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

# Base/default URL, when all else fails
urlpatterns += [
    url(r'', TemplateView.as_view(template_name='index.html')),
]

When I run the url http://127.0.0.1:8000/api/activity-list, the route that comes from the DRF router never gets reached. The server always seems to give precedence to the default URL, and index.html is always rendered.

However, if I change the Default URL to:

# Base/default URL, when all else fails
urlpatterns += [
    url(r'BLABLABLA', TemplateView.as_view(template_name='index.html')),
]

Only then are the DRF routes reachable. This is what makes me think it's a precedence issue. The DRF routes are working, they just always get beaten by the default URL.

I've tried variants suggested in the DRF docs, without luck, such as :

Moreover, /admin works fine, which is why I suspect that it has to do with the DRF router in particular.

But the same thing keeps happening. How can I make my DRF routes reachable while maintaining a default route for the server to land on?

Update: So I've found that adding a trailing slash to the api URL causes it to work. This has led me to these two (1 and 2) questions.

Jad S · Accepted Answer · 2016-09-12T01:59:29.513

3

Finally figured it out. According to the DRF docs:

By default the URLs created by SimpleRouter are appended with a trailing slash. This behavior can be modified by setting the trailing_slash argument to False when instantiating the router. For example:

router = SimpleRouter( trailing_slash = False )

Having set this as the setting of the router and transformed my route to r'activity-list', it now works with or without the trailing slash.

edited Sep 12 '16 at 01:59

answered Sep 09 '16 at 01:55

Jad S

2,705
6
29
49

Yep. Edited it. – Jad S Sep 12 '16 at 01:58

Kishor Pawar · Answer 2 · 2016-09-08T06:37:42.213

0

You will have to learn url dispatcher in django. Your default url's and DRF route's url's pattern is same, and default url is on top of the urlpatterns thus that url is getting triggered.

How Django processes a request

edited Sep 08 '16 at 06:37

answered Sep 08 '16 at 06:32

Kishor Pawar

3,386
3
28
61

How is it on top? I add it at the very bottom of the page and it's at the last index in the "urlpatterns" list – Jad S Sep 08 '16 at 11:43
Did you go through the link I given? – Kishor Pawar Sep 08 '16 at 12:19
if that was not helpful, we need your all `urls.py` files. – Kishor Pawar Sep 08 '16 at 12:25

Django DRF: Default URL always gets trigered first instead of route.url

2 Answers2