跳转到主要内容

Plone JSON API -- 路由

项目描述

Plone JSON API 路由

作者:

Ramon Bartl (RIDING BYTES - http://ridingbytes.com)

版本:

0.9.3

最新构建状态

主分支 https://github.com/collective/plone.jsonapi.routes

Build Status https://readthedocs.org/projects/pip/badge/

简介

这是一个plone.jsonapi.core的附加包,它提供了一些基本URL,用于Plone标准内容(以及更多)。

动机

routes包基于plone.jsonapi.core包构建,允许Plone开发者构建现代(JavaScript)Web UI,这些UI通过RESTful API与他们的Plone站点进行通信。

兼容性

plone.jsonapi.routes与Plone 4和5兼容。

文档

http://plonejsonapiroutes.readthedocs.org

源代码

https://github.com/collective/plone.jsonapi.routes/tree/master/docs

查看行动

在youtube上有一个小型的技术演示

http://www.youtube.com/watch?v=MiwgkWLMUqk

许可证

MIT - 随你做

变更日志

0.9.4 - 2017-10-17

变更

  • 合并大脑数据到对象信息

  • 处理Zope日期时间字段

  • 支持Backbone.js REST API

0.9.3 - 2017-05-14

变更

  • IDataManager 现在包含一个 json_data 方法,用于返回合适的JSON返回结构或委托给 IFieldManager.json_data 方法。请参阅文档中的“自定义”部分以获取更多详细信息。

  • 增加了对 z3c.relationfield.interfaces.IRelationList 字段的兼容性

  • 增加了对 plone.app.textfield.interfaces.IRichText 字段的兼容性

  • 增加了对 plone.app.blob.interfaces.IBlobField 字段的兼容性

  • 进行了更多的代码清理和重构(离1.0.0发布越来越近!)

0.9.2 - 2017-05-12

变更

  • getset 字段级别的值添加了 IFieldManager 适配器。

  • 从版本路由JSON响应中移除了 build 号码。

  • 内容路由得到了改进。

  • API重构。

  • 改进了 users 路由。

  • 更新了文档。

0.9.1 - 2017-04-20

变更

  • 添加了 ICatalogICatalogQuery 适配器,用于全面搜索控制。请参阅文档了解使用方法。

  • 移除了 query 模块,改用新的适配器。

  • 移除了多重目录查询功能。如果您需要,请定义自定义的 ICatalog 适配器。

  • 为所有 portal_types 添加了通用路由提供程序。请注意,旧式的路由提供程序,例如 foldersdocuments 等,现已过时。请使用较低的门户类型名称,例如 folderdocuememt 等。

  • users 路由现在显示了更多用户详细信息,并且结果现在已分批处理。

  • 移除了默认的 getObjPositionInParent 排序。请通过 sort_on 明确指定。

  • Plone站点的UID现在为‘0’而不是0。

  • 进行了大量代码重构和清理。

0.9.0 - 2017-01-12

变更

  • API方法 get_itemsget_batched 现在接受关键字参数。关键字可以是目录索引,例如 id=document-1 或完整的目录查询对象,例如 query={‘portal_type’: ‘Document’}

  • get_contents 方法更改为使用 query 模块的 search 功能。

  • 添加了更多 doctests。

0.8.9 - 2017-01-11

变更

  • 可以通过 catalog 请求参数设置查询目录。

  • 优化了搜索逻辑。

  • 修复了请求中多个 portal_type 参数的问题。

  • 代码重构。

  • 更多测试。

0.8.8 - 2017-01-10

变更

  • 处理多个内容(可能位于不同的目录中)的目录查询。

  • 修复了批导航在多个 portal_type 请求参数使用时没有显示更多结果的问题。

0.8.7 - 2017-01-10

变更

  • 处理引用字段:包含引用的引用字段可以使用字典更新,例如

    {
      uid: <UID of a content containing a reference field>,
      ReferenceField: {
        "title": "New Title"
      }
    }
  • 将模块 underscore 添加到测试套件中。

  • 为整个对象添加了验证。

  • 从 Archtype 工具获取查询目录,默认为 portal_catalog

  • 在路由提供程序中使用显式命名空间。

  • 处理引用字段(包含 ImplicitAcquisitionWrapper 对象的字段)

  • 添加了 ZCML 指令以启用/禁用路由注册(默认启用)

    <!-- Disable route registration -->
    <plone:jsonapi
        register_api_routes="False"
    />
  • 版本路由现在是标准路由提供程序的一部分

  • 删除了高级查询处理

0.8.6 - 2016-04-08

修复了损坏的发布 0.8.5

0.8.5 - 2016-04-08

已关闭问题

0.8.4 - 2016-01-14

已关闭问题

API更改

  • 可以显示对象的共享信息。使用?sharing=yes

0.8.3 - 2015-09-14

已关闭问题

API更改

  • 文件数据现在默认不包含。使用?filedata=yes

  • 工作流数据现在默认不包含。使用?workflow=yes

  • 工作流数据现在位于密钥workflow

  • 现在可以取消完整标志,即使显示完整对象时也是如此 ?complete=no

  • 已删除密钥state - 请使用 review_state 代替

  • 现在为脑结果包含父URL数据

0.8.2 - 2015-09-09

已关闭问题

0.8.1 - 2015-09-06

已关闭问题

增强功能

  • API操作以剪切/复制/粘贴内容

  • 新的路由提供者 plonesites

  • 支持目录脑模式

0.8 - 2015-07-20

已关闭问题

0.7 - 2015-07-09

已关闭问题

其他更改

  • 更新文档

  • 请求模块:添加了辅助函数

  • Travis CI 集成

0.6 - 2015-02-22

已关闭问题

0.5 - 2015-02-20

已关闭问题

其他更改

  • 添加批量适配器

  • 添加更多测试

0.4 - 2015-01-13

已修复问题

增强功能

其他更改

  • 添加了 IDataManager 字段数据管理器

  • 添加了 /auth 路由以强制基本身份验证

  • 添加了一个自定义异常类以设置正确的响应状态

  • 添加了 recent_modifiedrecent_created 处理

  • apirequest 模块添加了 unittests

  • 不再传递请求 - 现在所有请求都由请求模块处理

0.3 - 2014-10-14

已修复问题

增强功能

文档

0.2 - 2014-03-05

已修复问题

API更改

  • 提供API根URL。

  • 图像和文件字段现在以嵌套结构渲染,例如

    {
      data: b64,
      size: 42,
      content_type: "image/png"
    }
  • 尽可能提供工作流信息,例如

    {
      status: "Private",
      review_state: "private",
      transitions: [
        {
          url: ".../content_status_modify?workflow_action=submit",
          display: "Puts your item in a review queue, so it can be published on the site.",
          value: "submit"
        },
      ],
      workflow: "simple_publication_workflow"
    }

0.1 - 2014-01-23

  • 第一个公共版本

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

plone.jsonapi.routes-0.9.4.tar.gz (80.7 kB 查看哈希值)

上传时间

支持者