跳转到主要内容

为IMIO用例提供的扩展rest api服务

项目描述

https://travis-ci.cn/IMIO/imio.restapi.svg?branch=master https://coveralls.io/repos/github/IMIO/imio.restapi/badge.svg?branch=master PyPI badge

imio.restapi

plone.restapi 端点和适配

功能

  • 添加元素:

    • 带有子元素

    • 触发工作流转换

  • @pod-templates 端点(collective.documentgenerator)

  • 创建时禁用返回完整对象序列化:

    • 默认情况下,创建对象时返回完整对象序列化,有时会进行一些不必要的处理

    • 添加环境变量 RETURN_FULLOBJECT_AFTER_CREATION_DEFAULT False 将在创建对象时返回摘要序列化

    • 这将改变默认行为,但仍然可以通过在Body中定义 "return_fullobject": true/false 来为特定的POST更改此行为

待办事项

  • 在反序列化器中管理创建元素时触发的工作流转换,当我们只使用DX时

  • 在反序列化器级别包含 cleanHTML 功能,当我们只使用DX时

安装

通过将其添加到您的 buildout 中安装 imio.restapi

[buildout]

...

eggs =
    imio.restapi

然后运行 bin/buildout

贡献

许可证

本项目受GPLv2许可。

贡献者

  • Martin Peeters [Affinitic],原作者

变更日志

1.0rc2 (2024-05-27)

  • 使用 DELETE 时不要错过记录 restapi 调用。[gbastien]

1.0rc1 (2024-03-14)

  • 将未使用的 utils.listify 移动到 imio.pyutils.utils.listify。[gbastien]

  • 使用 base_search_uid 时,也考虑在 Collection 上定义的 sort_on/sort_order。[gbastien]

1.0b3 (2023-08-25)

  • 向设置中添加了参数 debug_mode,当启用时,输入和输出请求将显示在 Zope 日志中。[gbastien]

1.0b2 (2023-05-31)

  • 添加了辅助函数 utils.serialize_term,它将以与 FieldSerializer 相同的方式序列化词汇项。[gbastien]

1.0b1 (2022-01-03)

  • FolderPost.do_reply 中,如果发生错误,则不要继续,停止并立即返回带有错误的结果。[gbastien]

  • imio.restapi 设置面板中添加了 return_fullobject_after_creation_default,默认值为 True。这将返回创建对象后的完整序列化对象(这已经是当前的行为)。当设置为 False 时,将返回摘要序列化。[gbastien]

  • 修复了 @infos?include_stats=1 blobstorage 大小计算,以使用 .size.json。[gbastien]

1.0a15 (2021-11-08)

  • 覆盖 'update' 和 '工作流转换' 以使用 uid [vpiret]

1.0a14 (2021-07-16)

  • 避免在 metadata_fields 中重复。[gbastien]

  • @infos 中,如果 PWD 环境变量不可用,则尝试使用 INSTANCE_HOME 环境变量确定实例路径。[gbastien]

  • setup.py 中要求 plone.restapi<8,因为版本 8+ 仅供 Python3。[gbastien]

  • 由于 collective.documentgenerator 中的更改,修复了测试,其中名为 test_ods_templateConfigurablePODTemplateDocument 类型上不再可生成。[gbastien]

  • 添加了重新定义 metadata_fields 表单参数名称的可能性,例如可以通过子类覆盖。[gbastien]

1.0a13 (2021-02-15)

  • 清理 base_search_uid 参数以避免实例日志中的警告 [mpeeters]

  • @search 服务适配以使用上下文而不是使用可能在某些情况下有错误的 path 索引 [mpeeters]

1.0a12 (2021-02-03)

  • 通过允许 base_search_uid 参数使用除了 Collection 之外的元素 UID 来改进 @search,该参数可以用作基本路径 [mpeeters]

  • 将额外的 metadata_fields 管理从 SearchGet 服务移至为该服务创建的 DefaultJSONSummarySerializer,它将覆盖默认的 plone.restapi DefaultJSONSummarySerializer 并默认将 idUID 添加到结果中。[gbastien]

1.0a11 (2020-09-10)

  • 保留 FolderPost._after_reply_hook 为空(以前管理 wf_transitions),或者如果某个包覆盖了 _after_reply_hook 而忘记调用超类的原始方法,wf_transitions 可能会损坏。[gbastien]

1.0a10 (2020-06-28)

  • 在操作列表上添加类 [mpeeters]

1.0a9 (2020-06-24)

  • 改进 REST 词汇表的缓存 [mpeeters]

  • 仅当安装了包时才显示 imio-restapi-actionsimio-restapi-links 视图小部件(IImioRestapiLayer)[gbastien]

1.0a8 (2020-06-23)

  • 通过使用不带域的 id 改进对远程 rest 词汇表的过滤 [mpeeters]

  • 为链接使用 @relative_path 属性 [mpeeters]

  • 实现基础序列化器以添加 @relative_path 属性 [mpeeters]

1.0a7 (2020-06-23)

  • 修复使用 b_size 参数时搜索词汇表术语 id 的问题 [mpeeters]

1.0a6 (2020-06-23)

  • 修复视图小部件的权限问题 [mpeeters]

1.0a5 (2020-06-23)

  • 修复当没有正文时词汇表请求的错误 [mpeeters]

1.0a4 (2020-06-22)

  • 添加缺少的法语翻译 [mpeeters]

  • 实现请求的基本认证适配器 [mpeeters]

  • 添加一个适配器,允许在内容导入期间进行数据转换 [mpeeters]

  • 确保 REST 词汇表基类有上下文可用 [mpeeters]

  • 添加 @uid rest 服务 [mpeeters]

  • 添加 ImportForm 基类以从远程应用程序导入内容 [mpeeters]

  • 使 _request_schema 可选以处理更多用例 [mpeeters]

  • 添加 import_content 工具以从 rest 调用结果创建内容 [mpeeters]

  • 添加 get_application_url 和改进 generate_request_parameters 工具 [mpeeters]

  • 实现远程应用程序上对象搜索的基础词汇表类 [mpeeters]

  • 从基础词汇表类中移除 client_id 参数,因为该值直接设置在 zope 配置中 [mpeeters]

  • 为词汇表添加缓存 [mpeeters]

  • 更新翻译 [mpeeters]

  • 更新链接表单实现 [mpeeters]

  • 改进链接视图小部件 [mpeeters]

  • 实现 REST 链接的服务 [mpeeters]

  • 添加链接序列化器 [mpeeters]

  • @pod 端点 重命名为 @pod-templates 以更明确。端点 @pod-templates 现在是 @components 中可用的默认可扩展元素。[gbastien]

  • FolderPost.wf_transitions 调用移动到 FolderPost._after_reply_hook。如果 FolderPost.wf_transitions 中触发了转换,则更新 serialized_objreview_state 键。[gbastien]

  • 添加端点 @infos 以获取有关应用程序的各种信息。这取决于 Products.CPUtilsimio.pyutils。[gbastien]

  • 需要 plone.restapi>=6.13.3。[gbastien]

  • 覆盖 @search 默认端点,使其更容易完成,并成为子包的基类。添加对 base_search_uid 的管理,能够将 Collection UID 作为基查询给出。[gbastien]

1.0a3 (2020-06-08)

  • requests 添加到包依赖项 [mpeeters]

  • add.FolderPost.reply 中,调用 self.__class__ 而不是 FolderPost 以管理 children,以防我们从 FolderPost 继承。[gbastien]

  • 添加 add.FolderPost.prepare_data 以在调用将创建元素的 reply 之前准备数据。默认情况下,这将检查文件的正确性。[gbastien]

  • 添加 reply 后的钩子(_after_reply_hook)。[gbastien]

  • 如果在创建期间找到键 wf_transitions,则触发给定的 WF 转换。[gbastien]

  • FolderPost中增加了@warnings管理。[gbastien]

1.0a2 (2020-01-10)

  • 添加REST链接 [mpeeters]

  • 添加REST操作 [mpeeters]

  • 为REST交互添加基础表单类 [mpeeters]

  • 实现从json模式到z3c.form接口的转换器 [mpeeters]

  • 实现返回json模式模式的端点 [mpeeters]

  • 实现控制面板 [mpeeters]

  • 添加bulk端点 [mpeeters]

  • 添加获取Archetypes词汇值的端点 [mpeeters]

  • 添加包测试 [mpeeters]

  • 添加一个返回每个上下文的collective.documentgenerator可生成POD模板的端点@pod。这包括POD模板的信息和链接,可用于生成最终文档的可用输出格式。[gbastien]

1.0a1 (2018-12-04)

  • 首次发布。 [mpeeters]

项目详情


下载文件

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

源分布

imio.restapi-1.0rc2.tar.gz (47.6 kB 查看散列)

上传时间

支持者