「Django REST Framework 框架」Returning URLs返回链接解析及应用举例

妖狐艹你老母 2023-01-11 08:58 131阅读 0赞

### 文章目录 ###

*  内容介绍
 *  Returning URLs返回链接
 *  应用举例

# 内容介绍 #

开发环境为 Python3.6，Django 版本 3.0.x ，REST Framework 版本 3.12.x

全部内容索引目录  
**[看懂Django框架，没有最好只有更好][Django]**

通常最好是从 Web API 返回绝对 URL (比如http://example.com/foobar)，而不是相对 URL (比如 /foobar)。

# Returning URLs返回链接 #

框架提供了两个实用函数, 使得从 Web API 返回绝对 URL 变得更加简单。如果使用那么自描述 API 将能够自动为您超链接其输出，这使得浏览 API 更加容易。

用途：

1.  更加明确。
2.  为 API 客户端减少了工作。
3.  当在 JSON 等, 没有本机 URL 类型的表示中找到字符串时, 其含义没有任何歧义。
4.  使用超链接标记 HTML 表示之类的事情变得很容易。

# 应用举例 #

**1.reverse**

# 具有与 django.url.reverse 相同的行为
    # 但它返回一个完全限定的 URL (使用请求确定主机和端口)
    reverse(viewname, *args, **kwargs)
    
    
    # 将请求作为函数的关键字参数包括在内举例
    from rest_framework.reverse import reverse
    from rest_framework.views import APIView
    from django.utils.timezone import now
    
    class APIRootView(APIView):
        def get(self, request):
            year = now().year
            data = { 
                ...
                'year-summary-url': reverse('year-summary', args=[year], request=request)
            }
            return Response(data)

**2.reverse\_lazy**

# 具有和 django.url.reverse_lazy 相同的行为
    # 但它返回一个完全限定的 URL (使用请求来确定主机和端口)
    reverse_lazy(viewname, *args, **kwargs)
    
    
    # 与 reverse 函数一样
    # 应该将请求作为关键字参数包含到函数中
    api_root = reverse_lazy('api-root', request=request)

[Django]: https://blog.csdn.net/qq_20288327/article/details/117383454