brannonh / snapi-file
一个简单的PHP REST API,用于访问文件系统中的数据
v0.1.0
2021-01-25 16:46 UTC
This package is auto-updated.
Last update: 2024-09-26 00:47:20 UTC
README
一个简单的PHP REST API,用于访问文件系统中的数据
目的
这是一个极其轻量级的REST API,它使用(JSON)文件作为数据存储。只需命名您的存储并将它们指向一个文件,snAPI-File 将处理其余部分。
支持
如果您遇到任何问题,请通过打开新问题的方式让我们知道。
存储文件
您必须将 snAPI-File 指向您想要使用的存储。默认情况下,snAPI-File 从一个 stores.json
文件中加载这些内容,但是您可以通过构造函数来更改它(见下文)。
存储文件应采用以下格式。
{ "store1": "store1.json", "store2": "store2.json" }
在每个请求中发送正在使用的存储。只支持存储文件中引用的存储。任何其他引用的存储都将导致 HTTP 404 错误。
使用方法
设置
设置API很简单。只需创建您的存储文件并将以下行添加到您的PHP文件中。
use \SnapiFile\Api; $api = new Api(); $api->go();
这就完成了。snAPI-File 将处理后续的请求。
API
__construct($storeFile)
参数
返回值
go()
参数
返回值
客户端请求
对snAPI-File的请求必须是 GET
或 POST
,并且包含一组特定的参数。