cloudobjects/phpmae

phpMAE

镜像概述和主要用途

phpMAE（PHP Micro API Engine）是一个用于开发、执行和部署小型无状态Web API（称为“微API”）的框架。它基于Slim微框架构建，并利用PHPSandbox提供安全的运行环境。微API的配置和源代码可存储在CloudObjects Core中，当接收到特定API请求时，通过CloudObjects SDK即时部署到运行的phpMAE实例。该Docker镜像适用于在自有服务器（本地或云环境）上以 staging 或生产模式运行微API。

核心功能和特性

• 微API开发与部署：支持创建、验证和部署小型无状态Web API，公共方法通过RPC协议（如JSON-RPC）暴露
• 安全运行环境：基于PHPSandbox提供沙箱环境，限制危险函数和类的使用
• CloudObjects集成：与CloudObjects Core无缝集成，支持API配置和源码的存储与即时部署
• 多部署方式：提供Docker容器、PHAR文件和源码三种部署选项，Docker镜像为生产环境推荐方式

使用场景和适用范围

• 开发人员构建轻量级微API服务
• 企业自托管微API引擎，满足私有部署需求
• 需要快速部署和扩展的小型API服务场景
• 对API运行环境有安全隔离要求的应用

使用方法和配置说明

Docker镜像获取

预构建镜像可从Docker Hub获取：

bash
docker pull cloudobjects/phpmae

运行容器

运行容器时需提供环境变量以实现与CloudObjects的认证，否则仅能运行设置为公开可见（co:Public）的微API：

bash
docker run -e CO_AUTH_NS=example.com -e CO_AUTH_SECRET=XXXXXXXX -p 8080:80 cloudobjects/phpmae

环境变量说明

• CO_AUTH_NS：用于标识phpMAE实例身份的域名，需是已添加到CloudObjects的域名
• CO_AUTH_SECRET：该域名与cloudobjects.io之间的共享密钥，用于认证

获取认证密钥

通过CloudObjects CLI工具获取CO_AUTH_SECRET：

bash
cloudobjects domain-providers:secret example.com cloudobjects.io

（需先安装CloudObjects CLI工具）

访问微API

容器启动后，微API可通过http://<容器IP>:8080访问。私有微API需使用HTTP Basic认证：

• 用户名：CO_AUTH_NS指定的域名
• 密码：对应域名与phpmae.cloudobjects.io的共享密钥（通过CloudObjects CLI获取）

相关资源

• https://github.com/CloudObjects/phpMAE
• CloudObjects文档
• https://github.com/CloudObjects/phpMAE/wiki%EF%BC%88%E9%AB%98%E7%BA%A7%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E%EF%BC%89

许可协议

phpMAE基于Mozilla Public License许可（详见LICENSE文件）。