python restful api 学习笔记.2 快速开始

快速开始

我们将创建一个简单的API来允许管理员用户查看和编辑系统中的用户和组


项目设置

创建一个名为的新Django项目tutorial,然后开始一个名为的新应用程序quickstart。

django-admin.py startproject tutorial . # Note the trailing '.' charactercd tutorial

django-admin.py startapp quickstart

串行器

首先我们要定义一些序列化器。我们来创建一个名为tutorial/quickstart/serializers.py我们将用于数据表示的新模块。


python restful api 学习笔记.2 快速开始_第1张图片
在这种情况下,我们使用超链接关系HyperlinkedModelSerializer。您还可以使用主键和各种其他关系,但超链接是良好的RESTful设计。

查看

对,我们最好写一些意见。打开tutorial/quickstart/views.py并打字。


python restful api 学习笔记.2 快速开始_第2张图片

网址

好的,现在让我们连线API网址。关于tutorial/urls.py


python restful api 学习笔记.2 快速开始_第3张图片

因为我们使用视图集而不是视图,所以我们可以自动为我们的API生成URL conf,只需向路由器类注册视图集。

同样,如果我们需要更多地控制API URL,我们可以简单地使用常规的基于类的视图,并明确写入URL conf。

最后,我们将包括默认的登录和注销视图,以用于可浏览的API。这是可选的,但如果您的API需要身份验证并且您想使用可浏览的API,那么它很有用。


设置

添加'rest_framework'到INSTALLED_APPS。


测试我们的API

我们现在准备测试我们构建的API。让我们从命令行启动服务器。

python manage.py runserver

现在可以通过命令行访问我们的API,使用的工具如curl...

python restful api 学习笔记.2 快速开始_第4张图片

你可能感兴趣的:(python restful api 学习笔记.2 快速开始)