本教程主要介绍如何通过django-rest-framework快速创建rest风格的api。为了快速的演示,本教程使用django framework内置的user和group数据,并且使用sqlite数据库。
创建一个名为 tutorial的django项目,然后在创建一个名为quickstart的应用
接下来,我们同步相关的测试数据。(本教程为了降低环境的复杂性,默认使用sqlite数据)
同步完测试数据以后,创建一个初始的用户(admin)和密码(password1234) 用来在接下来的场景中进行身份的校验
当我们完成数据库和用户的初始化工作后,接下来就可以进入到编码阶段了
接下来我们创建用于数据序列化的代码。创建 tutorial/quickstart/serializers.py 文件
值得注意的是, 我们使用的是hyperlinkedmodelserializer. 你可以使用主键或者其他关系, 但使用hyperlinkedmodelserializer是一个好的 restful 设计
我们最好写一些view。 打开 tutorial/quickstart/views.py 写入以下内容
在django_rest_framework中, 所有常见的行为都被归到了viewsets中. 当然我们可以将这些行为分拆出来, 但使用viewsets, 使view的逻辑更为清楚.
接下来我们配置api的路由规则,在文件 tutorial/urls.py
因为我们使用的是viewset, 所以我们可以使用route class自动生成url conf.
在完成以上工作以后,我们需要进行一些必要的全局设置。例如我们需要打开分页功能,以及我们希望api只能让admin用户访问等。诸如此类的设置都可以在tutorial/settings.py中完成
现在,我们完成了全部的工作。接下里开始测试
至此我们的设置完成, 可以测试我们的rest api了, 首先启动django服务器:
至此我们可以访问我们的api