README

本项目使用模型-视图-控制器（MVC）架构编写。有关MVC架构的更多信息，请参阅MVC架构文章。该框架专为编写超级API端点而设计。它实现了JSON Web Token进行用户认证。请参阅JWT。

Postman 文档

安装成功后，请从根目录导入名为 saroboot.postman_collection.json 的Postman集合

安装和用法

此框架需要PHP 7.4或更高版本。
您可以在bash中简单地像下面这样克隆 saroboot

git clone https://github.com/angwa/saroboot.git

注意

文件夹应该克隆到xamp的htdocs文件夹或wamp的www文件夹中

下一步。非常重要

在bash上运行composer update

composer update

创建一个新的数据库，并导入根目录下db文件夹中的数据库文件database.sql。该数据库只包含我们用于演示的users表

下一步是配置您的环境。只需打开根目录中的config.php并编辑密码和数据库即可

<?php
namespace
{
    /**
     * Framework is written by Angwa, Ogbole Moses
     * The configuration variable to be used
     * Edit the file fields to fit your need
     * All fields are necesarry
     */
    class Config
    {
        public $env;
        public function __construct()
        {
            $this->env = array(
                'hostname' => 'localhost', //Your servername used for Database and JWT

                'username' => 'root',       //the server username

                'password' => 'mypassword',       // the server password

                'database' => 'saroboot',   //database name. can be your new database name
            );
        }
    }
}

路由

端点路由在项目根目录中的route.php文件中编写。例如，要创建一个名为login的路由，并使用POST方法，您可以这样做。

Route::add('/login', fn() =>LoginController::login(),'post');

使用此路由，您可以通过访问端点来访问，例如在本地的localhost上

127.0.0.1/saroboot/api/login

如果您的路由是GET方法，您可以在从Route类静态调用add函数时忽略最后一个参数

控制器

要能够与模型通信并发送数据到视图，在App/Controllers文件夹中创建一个控制器，并在App/Config/loader.php文件夹中使用spl_autoload_register()注册控制器

测试

要运行单元测试，请执行以下操作。

vendor/bin/phpunit

安全

如果您发现任何与安全相关的问题，请通过angwamoses@gmail.com发送电子邮件，而不是使用问题跟踪器。

鸣谢

• Angwa Moses

许可协议

MIT许可协议（MIT）。