brannonh/snapi-file
Composer 安装命令：
composer require brannonh/snapi-file
包简介
A simple PHP REST API to access data stored in the filesystem
README 文档
README
A simple PHP REST API to access data stored in the filesystem
Purpose
This is an extremely lightweight REST API that utilizes (JSON) files as data stores. Just name your stores and point them to a file, and snAPI-File will handle the rest.
Support
If you run into any problems, please let us know by opening a new issue.
Store File
You must point snAPI-File to the stores you want to use. By default, snAPI-File loads those from a stores.json file, however you may change that through the constructor (see below).
The store file should be in the following format.
{
"store1": "store1.json",
"store2": "store2.json"
}
The store being used is sent in each request. Only stores referenced in the store file are supported. Any other referenced store will result in an HTTP 404 error.
Usage
Setup
Setting up the API is simple. Just create your store file and add the following lines to your PHP file.
use \SnapiFile\Api; $api = new Api(); $api->go();
That's it. snAPI-File will handle the requests from there.
API
__construct($storeFile)
Parameters
| Parameter | Type | Required | Default | Notes |
|---|---|---|---|---|
$storeFile |
string | 'stores.json' |
The default file is created in the same directory as your PHP file. |
Returns
| Type | Notes |
|---|---|
Api |
The Api object |
go()
Parameters
| Parameter | Type | Required | Default | Notes |
|---|---|---|---|---|
| void |
Returns
| Type | Notes |
|---|---|
| void |
Client Requests
Requests to snAPI-File must be either GET or POST and include a specific set of parameters.
| Parameter | Required | Notes |
|---|---|---|
| store | ✔️ | The store to use |
| action | ✔️ | The action to perform (i.e., create, retrieve, update, delete) |
| key | The key in the store to affect Only required for create, update, and delete actions. Use with retrieve to get a specific record from the store. Omit from retrieve to get all records from the store. |
|
| value | ✔️ | The value to use to affect key |
brannonh/snapi-file 适用场景与选型建议
brannonh/snapi-file 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 10 次下载、GitHub Stars 达 1， 最近一次更新时间为 2021 年 01 月 25 日， 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向： 「json」 「filesystem」 「rest」 「data」 「api」 「Simple」 等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 brannonh/snapi-file 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 brannonh/snapi-file 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
与 brannonh/snapi-file 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：
A SDK for working with B2 cloud storage.
A PHP class providing static methods for reading, writing, copying, moving, and deleting files and directories, MIME type detection, image size detection, and file permission management
Kinikit - PHP Application development framework MVC component
The flysystem adapter for yandex disk rest api.
ext-json wrapper with sane defaults
A sleek PHP wrapper around rclone with Laravel-style fluent API syntax
统计信息
- 总下载量： 10
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 1
- 点击次数： 7
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： MIT
- 更新时间： 2021-01-25