你可能不知道的 Django Rest Framework 的两个新特性

前端、甚至大前端发展如此火爆的 2017 年(我相信 2018 年一样)刚过去,像 MVC 架构那样直接使用后端模板渲染前端页面的方式已经不被推崇了(当然有些场景下还是蛮适合的),交互的体验和难度都已经和 MVVM 架构的 Front-End 相差了 108000 Km -- 用户体验差,开发难度还高。现在是 VueJS / ReactJS / AngularJS 与使用 JSON 格式的 Back-End 交换数据的世界。作为一个 Django 使用者,DRF(Django Rest Framework,后面使用简称)也理所当然的变成 Django 开发者必学的一个 Package。


这篇文章我简单介绍一下 DRF 3.6 的两个新特性

1. 内置交互式API文档支持(Built-in interactive API documentation support)

新的 DRF API 交互式文档支持许多功能:

  • 实时 API 交互。
  • 支持各种认证方案。
  • Python,JavaScript 和 Command Line 客户端的代码片段。

依赖或可选的 Package:

  • coreapi Package 是本特性的依赖项,确保安装最新版本哦(2.3.0 或更高版本)
  • pygments Package 编程代码高亮(可选)
  • markdown Package markdown 语法高亮(可选)

要生效 API 交互文档特性,您仅需要这样将其包含在项目 URLconf 中:

from rest_framework.documentation import include_docs_urls

API_TITLE = 'API title'
API_DESCRIPTION = '...'

urlpatterns = [
    ...
    url(r'^docs/', include_docs_urls(title=API_TITLE,
                                     description=API_DESCRIPTION))]

2. 一个新的 JS 客户端库(A new JavaScript client library)

新的 JavaScript 客户端库允许您加载一种新的 API 模式,在应用程序层接口与该 API 交互,而不是显式构建提取请求(比如使用 axios 等前端类库)

下面是一个简短的例子,它演示了:

  • 加载客户端库和模式。
  • 实例化已认证的客户端。
  • 使用客户端进行 API 请求。
<html>
  <head>
    <script src="/static/rest_framework/js/coreapi-0.1.0.js"></script>
    <script src="/docs/schema.js"></script>
    <script>
        const coreapi = window.coreapi
        const schema = window.schema
        // Instantiate a client...
        let auth = coreapi.auth.TokenAuthentication({scheme: 'JWT', token: 'xxx'})
        let client = coreapi.Client({auth: auth})
        // Make an API request...
        client.action(schema, ['projects', 'list']).then(function(result) {
            alert(result)
        })
    </script>
  </head>
</html>

JavaScript 客户端库支持各种身份验证方案,可以由您的项目本身使用,也可以作为与 API 进行交互的外部客户端使用。

客户端不限于使用 REST 框架 API,尽管目前只支持加载 CoreJSON API 模式。后续将会计划支持 Swagger 和其他 API 模式。

有关更多详细信息,请参阅:

http://www.django-rest-framework.org/topics/api-clients/#javascript-client-library

原文发布于微信公众号 - 随心DevOps(heart-devops)

原文发表时间:2018-02-12

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏ChaMd5安全团队

pwnhub年前最后一战——“血月归来”writeup

一共两题,一题是固件逆向,一题是pwn。 key–逆向 这是一个嵌入式固件的逆向。 固件逆向,第一要做的就是确定片型和板型。 确定片型可以知道硬件资源,通用寄存...

3778
来自专栏数据分析

[译]Asp.net MVC 之 Contorllers(一)

Asp.net MVC contorllers     在Ajax全面开花的时代,ASP.NET Web Forms 开始慢慢变得落后。有人说,Ajax已经给了...

2757
来自专栏Linyb极客之路

详解PV、UV、VV、IP及其关系与计算

PV即Page View,网站浏览量,指页面浏览的次数,用以衡量网站用户访问的网页数量。用户每次打开一个页面便记录1次PV,多次打开同一页面则浏览量累计。一...

1112
来自专栏java思维导图

博客项目Tale思维导图,让项目不再难懂

写在前面 这次介绍的这个博客项目可以说有点另类,因为它使用的技术大部分都不是主流的技术,从前端到后端框架再到数据库的选择。当然,麻雀虽小但五脏俱全。技术的运用需...

3714
来自专栏超然的博客

JSONP && CORS

  前天面试被问到了跨域的问题,自我感觉回答的并不理想,下面我就分享一下整理后的总结分享给大家

912
来自专栏企鹅号快讯

前端三大框架vue,angular,react大杂烩

摘要:从angular的诞生独步天下,到现在三大框架平分天下,基本形势已经趋于稳定。每一个框架从诞生到受欢迎,都有其特定的原因和背景。不同的开发者选择时,也是依...

1926
来自专栏腾讯IVWEB团队的专栏

Web 推送技术

伴随着今年 Google I/O 大会的召开,一个很火的概念--Progressive Web Apps 诞生了。这代表着我们 web 端有了和原生 APP 媲...

1.2K0
来自专栏施炯的IoT开发专栏

《101 Windows Phone 7 Apps》读书笔记-ALARM CLOCK

课程内容 Ø 隔离存储空间 Ø 设置 Ø 设置页面向导 Ø Toggle Switch控件 Ø 使用自定义字体     Alarm Clock模仿的...

1706
来自专栏Create Sun

python 爬虫入门案例----爬取某站上海租房图片

前言   对于一个net开发这爬虫真真的以前没有写过。这段时间开始学习python爬虫,今天周末无聊写了一段代码爬取上海租房图片,其实很简短就是利用爬虫的第三方...

3547
来自专栏编程

前端三大框架大杂烩

摘要:从angular的诞生独步天下,到现在三大框架平分天下,基本形势已经趋于稳定。每一个框架从诞生到受欢迎,都有其特定的原因和背景。不同的开发者选择时,也是依...

2395

扫描关注云+社区