phplist/rest-api

phpList 的 REST API,全球最受欢迎的开源新闻邮件管理器

安装量: 2,077

依赖项: 1

建议者: 2

安全: 0

星标: 22

关注者: 9

分支: 12

开放问题: 24

类型:phplist-module

v4.0.0-alpha5 2021-03-06 17:03 UTC

README

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

关于 phpList

phpList 是一个开源新闻邮件管理器。

关于此包

此模块是 phpList 4 的 REST API,提供超级用户通过 REST 调用来管理列表、订阅者和订阅的功能。它使用了 phplist/core 模块(phpList 4 的核心)的功能。它不包含任何 SQL 查询,使用新核心的功能进行数据库访问。

此模块是可选的,也就是说,可以在没有 REST API 的情况下运行 phpList 4。

这个新的 REST API 也可以用来为现有的 phpList 3 安装提供 REST 访问。为此,phpList 3 的安装和带有 REST API 的 phpList 4 安装需要共享同一个数据库。不过,出于安全原因,不应该并行使用 phpList 3 和 phpList 4 的 REST API 访问同一个数据库。

安装

请通过 Composer 在 phpList 基础分发版 内安装此包,该分发版在 README 中也有更详细的安装说明。

API 文档

访问 /docs 端点,获取 phpList/rest-api 的完整交互式文档。

有关 API 文档的更多信息,请参阅 贡献指南 中的 "API 文档与 Swagger" 部分。

使用 Postman 的本地演示

您可以使用预准备请求和 Postman GUI 工具尝试 API。将 Postman 作为浏览器扩展或独立应用程序安装,打开 phpList 4 REST API 演示集合 并单击 "在 Postman 中运行"。

为此包做出贡献

请阅读 贡献指南,了解如何贡献以及如何在本地运行单元测试和样式检查。

行为准则

本项目遵守 贡献者行为准则。通过参与本项目及其社区,您应遵守此准则。