14.api根路由

我们可以通过使用超链接来提高我们APi的内聚力和可发现性

 

一、为我们的API创建一个根路径

我们的视图有很多个url，但是没有一个入口点，可以使用@api_view创建一个根路径

#views.py

from rest_framework.decorators import api_view
from rest_framework.response import Response
from rest_framework.reverse import reverse

@api_view(['GET'])
def api_root(request, format=None):
    return Response(
        {
            #key= 要显示的名称，value=对应的路径，我们可以使用reverse功能返回完整的url
            'users': reverse('user-list', request=request, format=format),
            'snippets': reverse('snippet-list', request=request, format=format),
        }
    )

#urls.py

# 默认根路径指向 api_root
path('', views.api_root),
# 为snippets指向别名 name='snippet-list'，该路径与api_root中的定义的key匹配
path('snippets/', views.SnippetList.as_view(), name='snippet-list'),
# 为users指向别名 name='user-list'，该路径与api_root中的定义的key匹配
path('users/', views.UserList.as_view(), name='user-list'),

效果

点击链接可以跳转对应页面