搜索davidfricker / restapi
简单的OOP MVC PHP REST API框架
Requires
- php: ^5.3.3 || ^7.0
- davidfricker/cleanjson: *
- davidfricker/dataabstracter: *
This package is not auto-updated.
Last update: 2024-09-17 04:46:28 UTC
README
这里有很多缩写。
注意：这是一份草稿文档
这个API框架并没有什么特别创新的地方。它源自我的计算机科学二年级项目，经过发展和重新思考，变成了现在您看到的样子。
它的关键卖点在于它的轻量级、简单易用、扩展和理解。
它是如何工作的？
简单来说，框架将请求路由到正确的控制器和模型。它通过分析请求URI中的控制器名称和请求类型（无论是POST、PUT、GET等）来实现这一点。然后，它将进行一些合理性检查，初始化一个新的控制器和模型对象，并在控制器上调用正确的方法。
我如何添加端点？
您必须在controllers文件夹中创建一个新的控制器。这个新的控制器必须扩展AbstractController。此外，您还必须创建相应的model并将其放在models文件夹中。新的模型必须扩展AbstractController。
我如何添加资源？
让我们以一个公开账户电子邮件地址用于更新的API为例。我们期望它的格式如下，PUT /accounts/email。要创建这个，必须首先创建一个账户控制器和模型。控制器必须声明一个以下格式的方法 public function put_email(){}。在这个方法内部，开发人员可以访问控制器对象本身的request对象 $this->request->get_parameter('new_address');。由于这个端点可能（希望）需要认证，应该执行成员函数is_authorised的调用。
重要信息
包含了一个.htaccess文件。它只是将所有请求重定向到索引文件。如果您不是使用apache作为您的web服务器，您需要将所有流量重定向到/index.php/$1，其中$1是剩余的URI。