webfiori/rest-easy

此包已被废弃,不再维护。作者建议使用 webfiori/http 包代替。

基本库,可以帮助使用PHP创建RESTful API。


README

一个简单的库,除了提供处理HTTP请求和响应的实用工具外,还可以创建RESTful Web API。它包括输入过滤和数据验证,以及创建用户定义的输入过滤器。

支持的PHP版本

API文档

此库是WebFiori框架的一部分。要访问库的API文档,您可以访问以下链接: https://webfiori.com/docs/webfiori/http .

术语

以下术语由库使用

想法

库的想法如下,当客户端对Web服务执行请求时,他通常对执行特定操作感兴趣。相关操作作为一组Web服务(例如对资源的CRUD操作)保存在一个地方。客户端可以在请求体中以POST或PUT请求方式传递参数(或参数),或者在使用GET或DELETE时作为查询字符串。

端点由类 AbstractWebService 表示,而一组Web服务(或端点)则使用类 WebServicesManager 进行分组。此外,由类 RequestParameter 表示的请求体参数。

功能

  • 全面支持创建支持JSON作为请求和响应的REST服务。
  • 支持基本数据过滤和验证。
  • 能够根据需要创建自定义过滤器。

安装

如果您使用composer来收集依赖项,您只需在您的'composer.json'文件中包含以下条目即可获取库的最新版本

{
    "require": {
        "webfiori/http":"*"
    }
}

请注意,WebFiori Json 库将随安装文件一起包含,因为此库依赖于它。

另一个选项是从 发布 手动下载最新版本。

用法

有关如何使用库的更多信息,请查看此处