Django REST framework 源码剖析-URL地址详解(Returning URLs)

Django REST framework 源码剖析-URL地址详解(Returning URLs)

• 从 Web API 返回绝对 URI (例如 http://example.com/foobar) 可能是比返回相对 URI (/foobar) 更好。
• REST framework 提供了两个实用函数，使从 Web API 返回绝对 URI 更加简单。
• 您无需使用它们，但如果您这样做，那么自描述 API 将能够自动为您超链接其输出，这使得浏览 API 更加容易。

优势

• 它更明确。
• 它为 API 客户端减少了工作量。
• 当在诸如 JSON 的表示中没有本地 URI 类型时，字符串的含义是没有歧义的。
• 它使得使用超链接标记 HTML 表示等事情变得很容易。

reverse

• 签名：reverse(viewname, *args, **kwargs)
• 具有与 django.urls.reverse 相同的行为，除了它返回一个完全限定的 URL，使用请求来确定主机和端口。

from rest_framework.reverse import reverse
from rest_framework.views import APIView
from django.utils.timezone import now
from rest_framework.response import Responseclass APIRootView(APIView):def get(self, request):year = now().yeardata = {...'year-summary-url': reverse('year-summary', args=[year], request=request)}return Response(data)

reverse_lazy

• 签名：reverse_lazy(viewname, *args, **kwargs)
• 具有与 django.urls.reverse_lazy 相同的行为，除了它返回一个完全限定的 URL，使用请求来确定主机和端口。

from rest_framework.reverse import reverse_lazy
from rest_framework.views import APIView
from django.utils.timezone import now
from rest_framework.response import Responseclass APIRootView(APIView):def get(self, request):year = now().yeardata = {...'year-summary-url': reverse_lazy('year-summary', args=[year], request=request)}return Response(data)