digitalbitlabs/simple-pi-framework

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

v2.0.1 2022-04-27 03:06 UTC

This package is auto-updated.

Last update: 2024-09-27 08:22:42 UTC


README

此仓库包含 Simple Pi 框架的源代码。要使用此框架创建项目或应用程序,请访问 https://github.com/digitalbitlabs/simple-pi

Simple Pi

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

安装

要安装 Simple Pi,您需要安装 composer。如果您还没有,请从 https://composer.php.ac.cn/download/ 下载

composer require 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 使用 Laravel 的 Capsule Manager 来执行数据库操作。有关更多信息,请访问 https://laravel.net.cn/api/8.x/Illuminate/Database/Capsule/Manager.html

根据 Laravel 的官方文档,以下驱动程序受 Capsule Manager 支持。

  • MariaDB 10.2+
  • MySQL 5.7+
  • PostgreSQL 10.0+
  • SQLite 3.8.8+
  • SQL Server 2017+

要执行查询以选择数据,只需在控制器或 routes.php 文件顶部添加相应的行即可

use SimplePi\Framework\DB;

然后要获取任何表的记录,只需使用 Laravel 提供的 ORM 函数。有关更多信息,请访问 https://laravel.net.cn/docs/9.x/database。例如,在 Simple Pi 中,查询 SELECT * FROM demo 可以按以下方式运行

DB::table('demo')->get()->toArray();

就这样。您将在数据库表中获取数据数组。

要执行删除、更新或插入等附加操作,请使用 CapsuleManager 类中的相应函数。函数可以以类似 Laravel eloquent 的方式执行。您可以参考 Laravel eloquent 文档以获取更多详细信息。

致谢

此框架是由 Sanket RautDigitalbit Labs 的业余项目中开发的,目的是编写一个尽可能简单的裸金属框架。