audriga/jmap-openxport

为现有基于PHP的系统提供JMAP支持,在OpenXPort项目背景下

1.7.2 2024-01-11 12:47 UTC

README

OpenXPort数据可移植性框架简化了数据迁移端点的开发。

用户应能轻松地从其他服务迁移到您的服务,反之亦然。OpenXPort使公开RESTful API端点以实现数据可移植性变得简单。它基于互操作协议JMAP,该协议已经支持多种数据类型,并可以扩展以支持更多。

OpenXPort目前支持以下数据类型

OpenXPort考虑到与旧系统的兼容性。我们支持所有5.6及以下版本的PHP,以提供对旧系统的数据可移植性。

安装

本地安装

  1. 运行make以初始化默认PHP版本(8.1)的项目。如果您需要为不同版本构建,请使用其他构建目标(例如make php56_modemake php70_mode)。

开发

安装

  1. 运行make或上述旧PHP版本的任何目标。
  2. 运行make update以更新依赖项并使开发工具可用

测试

要运行所有测试,请运行make fulltest。这需要Podman(用于静态分析)和Ansible(用于集成测试)。

您也可以单独运行它们

  • 静态分析通过make lint
  • 单元测试通过make unit_test
  • 集成测试通过make integration_test(更多信息请参阅tests/integration/README.md