Making sure our URL patterns are named

If we're going to have a hyperlinked API, we need to make sure we name our URL patterns. Let's take a look at which URL patterns we need to name.

  • The root of our API refers to 'user-list' and 'snippet-list'.
  • Our snippet serializer includes a field that refers to 'snippet-highlight'.
  • Our user serializer includes a field that refers to 'snippet-detail'.
  • Our snippet and user serializers include 'url' fields that by default will refer to '{model_name}-detail', which in this case will be 'snippet-detail' and 'user-detail'.

After adding all those names into our URLconf, our final snippets/urls.py file should look like this:

  1. from django.urls import path
  2. from rest_framework.urlpatterns import format_suffix_patterns
  3. from snippets import views
  5. # API endpoints
  6. urlpatterns = format_suffix_patterns([
  7.     path('', views.api_root),
  8.     path('snippets/',
  9.         views.SnippetList.as_view(),
  10.         name='snippet-list'),
  11.     path('snippets/<int:pk>/',
  12.         views.SnippetDetail.as_view(),
  13.         name='snippet-detail'),
  14.     path('snippets/<int:pk>/highlight/',
  15.         views.SnippetHighlight.as_view(),
  16.         name='snippet-highlight'),
  17.     path('users/',
  18.         views.UserList.as_view(),
  19.         name='user-list'),
  20.     path('users/<int:pk>/',
  21.         views.UserDetail.as_view(),
  22.         name='user-detail')
  23. ])