digitalbitlabs/simple-pi

Simple Pi 是一个用 PHP 开发的 REST API 框架

v1.1.0 2022-04-14 05:55 UTC

This package is auto-updated.

Last update: 2024-09-27 08:27:58 UTC


README

Simple Pi

Simple Pi 是一个用 PHP 开发的 REST API 微框架。该框架的唯一目的是提供一个现成的简单 API,允许您自定义配置、路由和数据库操作。要开始使用该框架,请按照以下步骤进行:

安装

要安装 Simple Pi,您需要已安装 composer。如果还没有,可以从 https://getcomposer.org.cn/download/ 下载。

composer create-project digitalbitlabs/simple-pi my-app

这将在您的当前文件夹中创建一个名为 my-app 的目录,其中包含运行 API 所需的所有代码。

设置环境文件

进入 my-app 目录,并将 .env.example 文件 重命名为 .env

配置数据库和应用

根据需要自定义 .env 文件中的配置参数。您还可以更新位于应用程序根目录中 app 文件夹内的 config.php 文件中的设置。

设置应用程序路由

通过在应用程序根目录中 app 文件夹内的 routes.php 文件中更改或添加应用程序路由。

运行应用程序

要运行您刚创建的应用程序,请从应用程序的根目录中在终端运行以下命令。

php -S localhost:8000 -t public\

控制器

控制器是用于将相似操作组合在一起的定制类。它们可以在 app\controllers 类内部创建。仓库代码中已存在一个演示控制器。

数据库操作

Simple Pi 使用 PHP PDO 对象来运行数据库查询。以下驱动程序根据 php.net 文档支持。

  • CUBRID (PDO)
  • MS SQL Server (PDO)
  • Firebird (PDO)
  • IBM (PDO)
  • Informix (PDO)
  • MySQL (PDO)
  • MS SQL Server (PDO)
  • Oracle (PDO)
  • ODBC 和 DB2 (PDO)
  • PostgreSQL (PDO)
  • SQLite (PDO)

要执行查询,只需在控制器或 routes.php 文件的顶部添加以下行:

use SimplePi\Framework\DB;

然后使用 DB::query()->result() 函数运行查询并获取结果。

DB::query("SELECT * FROM foo")->result();

就这样。您将得到数据库表的一个数组。

鸣谢

此框架由 Sanket RautDigitalbit Labs 作为一项爱好项目开发,旨在编写一个尽可能简单的裸金属框架。