Django之Restful API
理解Restful架构:http://www.ruanyifeng.com/blog/2011/09/restful
RESTful设计指南:http://www.ruanyifeng.com/blog/2014/05/restful_api.html
Django REST framework文档:http://www.django-rest-framework.org/#installation
Django RESTful 中文翻译:http://blog.csdn.net/ppppfly/article/category/6170709
基于Django的RESTful安装
第一步:使用pip安装:
pip install djangorestframework
第二步:添加rest_framework
到settings中的INSTALLED_APPS
中:
INSTALLED_APPS = ( ... 'rest_framework', )
如果你需要使用浏览器API,需要添加REST framework的登录注销模块,需要将下面的代码添加到urls.py中:
urlpatterns = [
...
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]
注意:URL路径可以任意编写,但你必须include 'rest_framework.urls'
,且使用'rest_framework'
这个namespace(命名空间)。如果你的Django是1.9+版本,你也可以不写namespace
,REST framework会帮你自动设置。
例子
让我们看一个简单用例:如何用REST framework 来搭建一个简单的支持modle的API。
我们将创建一个读/写API,来处理我们项目中的用户信息。
任何REST framework的全局设置,都存放在一个配置字典(dictionary,有些语言如Java中的map)中,名为REST_FRAMEWORK
。我们从以下的操作开始,把下面的内容添加到你的settings.py模块中:
REST_FRAMEWORK = {
# 使用Django的标准`django.contrib.auth`权限管理类,
# 或者为尚未认证的用户,赋予只读权限.
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
]
}
别忘了,确保你已经将 rest_framework 添加到你的INSTALLED_APPS中。
现在我们已做好准备,来创建我们的API了。这是我们的项目根下urls.py模块:
from django.conf.urls import url, include
from django.contrib.auth.models import User
from rest_framework import routers, serializers, viewsets
# Serializers定义了API的表现形式.
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ('url', 'username', 'email', 'is_staff')
# ViewSets 定义了 视图(view) 的行为.
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
# Routers 提供了一种简单途径,自动地配置了URL。
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
# 使用自动的URL路由,让我们的API跑起来。
# 此外,我们也包括了登入可视化API的URLs。
urlpatterns = [
url(r'^', include(router.urls)),
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]
现在你可以在浏览器的http://127.0.0.1:8000/里,打开你新建的’users’ API了。使用右上角的登陆控制,可以对系统用户进行新增和删除操作
rest_searializer.py:
from django.conf.urls import url, include
#从已存在的assets项目中导入数据models模块
from assets import models
from rest_framework import routers,serializers,viewsets
#定义一个表现形式
class UserSerializer(serializers.ModelSeriallizer):
class Meta:
model = models.UserProfile
fields = ('username','name','token','email','is_staff')
class AssetSerializer(serializers.ModelSerializer):
class Meta:
model = models.Asset
...
from rest_framework import viewsets
from assets import models
from assets import rest_searializer
class UserViewSet(viewsets.ModelViewSet):
queryset = models.UserProfile.objects.all()
serializer_class = rest_searializer.UserSerializer
class AssetViewSet(viewsets.ModelViewSet):
queryset = models.Asset.objects.all()
serializer_class = rest_searializer.AssetSerializer
rest_urls.py:
from rest_framework import routers
from django.conf.urls import url,include
from assets import rest_viewset
router = routers.DefaultRouter()
router.register(r'users',rest_viewset.UserViewSet)
router.register(r'assets',rest_viewset.AssetViewSet)
router.register(r'manufactory',rest_viewset.ManufactoryViewSet)
router.register(r'business_unit',rest_viewset.BusinessUnitViewSet)
urlpatterns = [
url(r'',include(router.urls)),
url(r'^api-auth',include('rest_framework.urls',namespace='rest_framework'))
]
settings.py:
REST_FRAMEWORK = {
# 使用Django的标准`django.contrib.auth`权限管理类,
# 或者为尚未认证的用户,赋予只读权限.
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
]
}
使用API插入数据的例子,views.py中:
def api_test(request):
if request.method =="GET":
return render(request,"test_post.html")
else:
data = json.loads(request.POST.get("data"))
print("--->",data)
rest_obj = rest_searializer.AssetSerializer(data=data,many=True)
if rest_obj.is_valid():
rest_obj.save()
return render(request,"test_post.html",{"errors":rest_obj.errors,"data":rest_obj.data})
其中many=true
,是将queryset多对多序列化,详细参数后面会有表述.
dss.Serializer 提供序列器
function serializer(data, datetime_format='timestamp', output_type='raw', include_attr=None, except_attr=None, foreign=False, many=False)
Parameters:
data(Required|(QuerySet, Page, list, django model object))-待处理数据
datetime_format(Optional|string)-如果包含 datetime 将 datetime 转换成相应格式.默认为 "timestamp"(时间戳)
output_type(Optional|string)-serialize type. 默认“ raw ”原始数据,即返回 list 或 dict
include_attr(Optional|(list, tuple))-只序列化 include_attr 列表里的字段。默认为 None
exclude_attr(Optional|(list, tuple))-不序列化 except_attr 列表里的字段。默认为 None
foreign(Optional|bool)-是否序列化 ForeignKeyField 。 include_attr 与 exclude_attr 对 ForeignKeyField 依旧有效。 默认为 False
many(Optional|bool)-是否序列化 ManyToManyField 。 include_attr 与 exclude_attr 对 ManyToManyField 依旧有效 默认为 False
Django之Restful API的更多相关文章
- Django编写RESTful API(一):序列化
欢迎访问我的个人网站:www.comingnext.cn 关于RESTful API 现在,在开发的过程中,我们经常会听到前后端分离这个技术名词,顾名思义,就是前台的开发和后台的开发分离开.这个技术方 ...
- Django编写RESTful API(四):认证和权限
欢迎访问我的个人网站:www.comingnext.cn 前言: 按照前面几篇文章里那样做,使用Django编写RESTful API的基本功能已经像模像样了.我们可以通过不同的URL访问到不同的资源 ...
- python 全栈开发,Day95(RESTful API介绍,基于Django实现RESTful API,DRF 序列化)
昨日内容回顾 1. rest framework serializer(序列化)的简单使用 QuerySet([ obj, obj, obj]) --> JSON格式数据 0. 安装和导入: p ...
- Django编写RESTful API(二):请求和响应
欢迎访问我的个人网站:www.comingnext.cn 前言 在上一篇文章,已经实现了访问指定URL就返回了指定的数据,这也体现了RESTful API的一个理念,每一个URL代表着一个资源.当然我 ...
- 利用Django实现RESTful API(一)
RESTful API现在很流行,这里是它的介绍 理解RESTful架构和 RESTful API设计指南.按照Django的常规方法当然也可以实现REST,但有一种更快捷.强大的方法,那就是 Dja ...
- 使用Django创建RESTful API
Agenda 1.What is an api Api refers to application programming interface It is a set of subroutine de ...
- Django编写RESTful API(五):添加超链接提高模型间的关联性
前言 在第四篇中,加入了用户模型,以及相关的认证和权限的功能.但是我们在使用的时候,会发现在访问http://127.0.0.1:8000/users/时看到的用户列表,不能够直接点击某个链接然后查看 ...
- Django编写RESTful API(六):ViewSets和Routers
欢迎访问我的个人网站:www.comingnext.cn 前言 在本系列的文章中,我在第一篇和第二篇文章中写的编写Django视图时,使用的都是基于函数的方法,并且每个视图函数之前都会加一个djang ...
- Python用Django写restful api接口
用Python如何写一个接口呢,首先得要有数据,可以用我们在网站上爬的数据,在上一篇文章中写了如何用Python爬虫,有兴趣的可以看看: https://www.cnblogs.com/sixrain ...
随机推荐
- django模型类
模型类 ORM django中内嵌了ORM框架,ORM框架可以将类和数据表进行对应起来,只需要通过类和对象就可以对数据表进行操作. 在Django中主要是设计类:模型类. ORM另外一个作用:根据设计 ...
- linux 下安装 nginx 及所需的各种软件工具
我当前的虚拟机是 vmware 15,用的镜像是centOs 7 CentOS-7-x86_64-DVD-1810.iso 确保你的虚拟机是通网的. 1.如果是新环境,没安装过gcc,那么先安装这个. ...
- thinkpadT470P安装问题
[问题描述]: 最近在将Thinkpad E430c的ubuntu系统重装成windows 7的过程中,出现了装好win7系统后,开机自动进入boot menu界面的问题,而且不论你选择从光驱还是硬盘 ...
- Linux系统性能10条命令
概述 通过执行以下命令,可以在1分钟内对系统资源使用情况有个大致的了解. uptime dmesg | tail vmstat 1 mpstat -P ALL 1 pidstat 1 iostat - ...
- $spfa-dfs$优化板子
\(spfa-dfs\)优化板子 快速判断是否存在负环(没负环时不要作死用) bool spfa(int u){ vis[u]=1; for(register int i=head[u];i;i=nx ...
- Pytest权威教程15-运行Nose用例
目录 运行Nose用例 使用方法 支持的nose风格 不支持的习语/已知问题 返回: Pytest权威教程 运行Nose用例 Pytest基本支持运行Nose框架格式的测试用例. 使用方法 后安装py ...
- UOJ#121. 【NOI2013】向量内积 随机化算法,矩阵
原文链接www.cnblogs.com/zhouzhendong/UOJ121.html 前言 完蛋了我越来越菜了贺题都不会了. 题解 $O(n ^ 2 d) $ 暴力送 60 分. Bitset 优 ...
- C++标准库分析总结(九)——<HashFunction、Tuple>
一.HashFunction 当我们在使用hash table以及由它做底层的数据结构时,我们必不可少要讨论hash function,所谓的哈希函数就是产生一个数,这个数越乱越好,以至于达到避免碰撞 ...
- vue中如何动态添加readonly属性
动态绑定input的readonly属性 1 <inpu :readonly="status ? false : 'readonly'"> status 为 false ...
- elasticsearch routing
当索引一个文档的时候,文档会被存储到一个主分片中. Elasticsearch 如何知道一个文档应该存放到哪个分片中呢?当我们创建文档时,它如何决定这个文档应当被存储在分片 1 还是分片 2 中呢?首 ...