README

关于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不应在相同数据库上并行使用。

请从phpList基础分发版内部使用Composer安装此包，README中也有更详细的安装说明。

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

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

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

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

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