djangorestframework文档,django rest framework jwt
姜戈休息框架(翻译的官方工具书)神奇的浏览器API .
姜戈休息框架可以轻松部署web APIs,其是一个聚健壮性与弹性于一体的网工具包。
以下所列可以作为选择其的理由:
网可浏览应用程序接口对于开发者来说足以胜任网开发。身份验证策略内包括OAuth1a和OAuth2 .对象关系映射(Object Relation Mapping)和非对象关系映射(Object Relation Mapping)数据源都支持序列化。如果你不要使用更强力的工具只需使用基于函数的常规视图。深度讲解的文档和多角度的社区支持。下面是生动的网实例。
下图:来自可浏览应用程序接口的截图
要求:休息需要以下部件:
Python (2.6.5,2.7,3.2,3.3)Django (1.3,1.4,1.5,1.6)如下是可选组件:
降价(2.1.0)对可浏览应用程序接口的降价支持派亚马尔(3.10 ) - YAML内容类型支持defusedxml (0.3 ) - XML内容类型支持django-滤波器(0.5.4)过滤支持100 . django-oauth-plus(2.0)和oauth2 (1.5.211 ) - OAuth 1.0a支持100 .姜戈-瓦乌斯2-提供者(0.2.3 ) - OAuth 2.0支持100 . django-guardian(1 . 1 . 1)对象级权限支持。注意:oauth2 Python包严重名不副实,实际上提供了OAuth 1.0a支持。还要注意,OAuth 1.0a和OAuth 2.0所需的包还不兼容Python 3 .
安装使用皮普,其内包涵很多部件.
点安装djangorestframework
点安装降价#对可浏览应用程序接口的减价支持。
点安装django-过滤器#过滤支持.或者可以从github chone .
饭桶克隆git @ github。com:Tom Christie/django-rest-framework。饭桶将 rest_framework 添加到已安装的应用程序设置中。
INSTALLED_APPS=(
.
rest_framework ,
)如果你想要使用网浏览器蜜蜂并且想添加休息框架的登出与登录视图。将下面的密码添加到urls.py文件中。
urlpatterns=模式(,
.
url(r^api-auth/,包含( rest_framework.urls ,命名空间=rest_framework ))
)注意:
统一资源定位器路径可以放在任何地方,但是你必须把 rest_framework.urls
包涵在 rest_framework
中。列子:迅速的看一下用休息框架搭建的一个简单的模块API .
我们将创建一个提供读写用户和组的API .
任何设置为休息框架的应用程序接口都被放入一个命名REST _框架的文件中.然后把其添加到settings.py模块中:
REST_FRAMEWORK={
#默认情况下使用超链接样式。
#仅在视图上未设置"序列化程序_类"属性时使用。
DEFAULT_MODEL_SERIALIZER_CLASS :
rest _框架。序列化程序。 hyperlinkedmodelserializer ,
#使用姜戈的标准" django.contrib.auth "权限,
#或者允许未经身份验证的用户进行只读访问。
DEFAULT _ PERMISSION _ class :[
rest _框架。权限。 djangodelpermissionsoranonreadonly
]
} 不要忘记把休息_框架添加到已安装的应用程序。如今已经为创建应用程序接口做好准备。如下是工程的跟urls.py模块:
从django.conf.urls.defaults导入网址,模式、包含
从django.contrib.auth.models导入用户,组
从rest _框架导入视图集,路由器
#视图集定义视图行为。
类用户视图集(视图集ModelViewSet):
型号=用户
类组视图集(视图集ModelViewSet):
模型=组
#路由器提供了一种自动确定统一资源定位器配置的简单方法
路由器=路由器。默认路由器()
router.register(rusers ,UserViewSet)
router.register(rgroups ,GroupViewSet)
#使用自动统一资源定位器路由连接我们的API .
#此外,我们还包括可浏览应用程序接口的登录URL .
urlpatterns=模式(,
url(r^,包括(router.urls)),
url(r^api-auth/,包含( rest_framework.urls ,命名空间=rest_framework ))
)快速开始等不及开始了?快速导航是一个简易的步骤,并可以创建休息框架的API .
指南书:本教程将带您浏览构成休息框架的构件。这将需要一点时间来完成,但它会让你全面了解一切是如何结合在一起的,强烈推荐阅读。
1 -串行化2 -请求响应3 -基于类的视图4 -认证许可5 -关系超链接API 6-视图集路由器应用程序接口指南应用程序接口指南是休息框架提供的所有功能的完整参考手册。
请求响应视图通用视图视图集路由器解析器呈现器序列化器序列化器字段序列化器关系身份验证权限限制过滤分页内容协商格式后缀返回统一资源定位器异常状态代码测试设置主题:休息使用指南。
记录你的API阿贾克斯,CSRF CORS浏览器增强可浏览API REST,超媒体HATEOAS 2.0发布2.2发布2.3发布发布说明信用开发如果你想在休息框架本身上工作,克隆存储库,然后.
构建文档:/mkdocs.py运行测试:/rest _ framework/runtests/runtests。巴拉圭要针对所有支持的配置运行测试,首先使用pip安装毒性全局安装毒药测试工具,然后只需运行毒性:
要获得支持,请查看REST框架讨论组,尝试irc.freenode.net上的#restframework频道,搜索因特网中继会谈档案,或者提出关于堆栈溢出的问题,确保包括" django-rest-框架"标记。
付费支持可从达巴普斯获得,可包括休息框架核心工作,或支持构建您的休息框架API .如果您想讨论商业支持选项,请联系达巴普斯.
关于休息框架开发的更新,您可能还想在推特上关注作者。
跟随@汤姆克里斯蒂
安全性如果你认为你在姜戈休息框架中发现了一些安全隐患,请不要在公共论坛上提出这个问题。
通过电子邮件向rest-framework-security@googlegroups.com发送问题描述。在任何公开披露之前,项目维护者将与你一起解决任何需要解决的问题。
许可版权2011年至2013年,汤姆克里斯蒂保留所有权利。
只要满足以下条件,允许以源代码和二进制形式(修改或不修改)重新分发和使用:
源代码的再分发必须保留上述版权声明、此条件列表和以下免责声明。二进制形式的再分发必须在随分发提供的文档和/或其他材料中复制上述版权声明、此条件列表和以下免责声明。
本软件由版权所有者和贡献者"按原样"提供,拒绝任何明示或暗示的担保,包括但不限于对适销性和特定用途适用性的暗示担保。在任何情况下,版权所有者或贡献者都不对任何直接、间接、附带、特殊、惩戒性或后果性损害(包括但不限于替代商品或服务的采购;用途、数据或利润的损失;或业务中断)以及任何责任理论,无论是合同责任、严格责任还是因使用本软件而产生的侵权行为(包括疏忽或其他),即使已被告知此类损害的可能性。
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。