django rest框架的json api引用实现

drfjsonapi的Python项目详细描述


build-status-imagepypi-version

概述

django rest框架的json api引用实现

这是JSONAPI1.0规范的一个非常彻底的实现 对于django rest框架。对不符合项有严格的错误处理 客户&;遵循规范中的所有必备项(或很快就会丢失)。

已知的不完整的json api规范特性/准则是:

  • 错误对象指针
  • “关系链接”

错误对象指针目前不是很好。它处理场级, 资源级别,&relationship“指针”结构很好,但我 不要认为它会处理任何类型的复杂嵌套字段错误。这个 指针可能不准确。我得试着想办法 对于drf,它是本机validationerror字段名。

当你看RFC6901的时候,这很重要。我们可能需要更坚固的东西 这里是drfjsonapi需要的附加drf插件。

关系链接是关系的links对象的“self”成员。 目前,ember不支持该端点的关系修改。 所以我还没有写的动力。话虽如此,有些抽象 已经在这个库中编写了,以便在 未来。

除了那些已知的限制之外,这个库真的很完整。一吨 将注意力集中在有意义的错误和良好的异常处理上。 我知道在这方面还需要做的更多,但是 这些增强功能无需担心json api规范。

当前实现的值得注意的特性的细目 json api服务器实现是:

  • filter查询参数(跨越关系)
  • include查询参数(跨越关系)
  • page查询参数
  • sort查询参数
  • 相关资源链接
  • 非常容易理解的代码
  • 全面的错误处理(解析器、序列化器、视图等)
  • 合并时出错
  • json api处理管道几乎每个部分的钩子
  • 优质代码注释

要求

  • Python(2.7,3.3,3.4)
  • Django(1.6、1.7、1.8)
  • django rest框架(2.4、3.0、3.1)

安装

使用pip

安装
$ pip install drfjsonapi

示例

待办事项:写例子。

测试

安装测试要求。

$ pip install -r requirements.txt

使用运行测试运行。

$ ./runtests.py

您还可以使用优秀的tox测试工具来运行测试 针对所有受支持的python和django版本。安装TOX 全局,然后简单地运行:

$ tox

文档

要构建文档,您需要安装mkdocs

$ pip install mkdocs

预览文档:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

构建文档:

$ mkdocs build

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java为什么参数。getType()。isInstance(HttpServletRequest.class)返回值为false,但use“==”为true   使用Java的文本文件中的简单列表   linux Java创建具有特定所有者(用户/组)的文件和目录   java我试图解析一个文本文件,以计数唯一字符串的数量,并打印一些关于这些字符串的信息   雅加达ee如何使用JavaEE6@Resource注释   java从数据库中获取所有值,并将其存储在字符串数组中   java需要ArrayList中的单个数组   java变量id可能未使用lombok初始化Spring引导控制器   JavaS3客户端。读取超过文件大小时的GetObject行为   java在另一个活动列表视图中显示JSONObject   java spring引导fat jar注册到带有奇怪端口的eureka   java如何与mongoDB建立Android Studio连接?   java LinkedIn OAuth2/oauth/v2/accessToken响应未返回“令牌类型”   java如何在jtree中只列出非隐藏和非系统文件   Mybatis批量将Java BigDecimal插入SQL Server decimal(18,2)无法正常工作   java Hibernate Criteria Builder:如何按可为空的实体属性进行筛选?   如果涉及方法内变量的范围,python与java是否不同?   java如何实现web服务客户端,该客户端通过基于NTLM身份验证的身份验证连接到外部web服务   java使Jackson在反序列化期间无法将double转换为int