raeen / bamboo
Bamboo 是一个 PHP API 框架
1.0.0
2021-03-25 13:30 UTC
Requires
- bramus/router: ~1.5
- vlucas/phpdotenv: ^5.3
README
Bamboo
Bamboo 是一个 PHP API 框架。非常简单、轻量级。由 Raeen Ahani 于 2021 年在伊朗戈尔甘创建
安装
composer create-project raeen/bamboo
文档
数据库
要连接到 MySQL 数据库,请参考 .env
路由器
我们使用 bramus/router 作为路由器,当然我们对其进行了自定义,以便默认情况下在控制器中执行发送方法的函数
方法
发送到控制器的函数存储在 $method
( $this->method
) 变量中
路径
页面地址存储在控制器的 $path
( $this->path
) 变量中
数据
发送到 API 的数据存储在控制器的 $data
( $this->data
) 变量中
文件
文件信息存储在控制器的 $files
( $this->files
) 变量中
文件下载到存档文件夹中。要下载,请使用控制器中的 download(key of file , save File name = null)
函数。
在控制器中使用 sendFile(file name)
函数发送文件
认证
对于 HTTP 认证头,请在控制器中使用 auth(username, password)
函数
API 密钥
在控制器中使用 apikey(length = 20)
函数创建 API 密钥
查询
在控制器中使用 DB::query(sql query, parameters ...)
函数进行 SQL 查询。此函数使用 pdo,例如
$query = DB::query("SELECT * FROM user WHERE name=?", $name); $result = $query->fetch(PDO::FETCH_OBJ);
渲染
在控制器中使用 render(int $code, array | object $data = null, $status = null, $message = null)
发送结果作为 JSON。默认情况下,消息和状态由代码完成