README

此存储库在此处不再维护。项目现在托管在 GitLab 上的 apinephp/legacy-framework。

APIne 是一个简单易用的模块化 MVC 框架，适用于作为 RESTful API 使用。它旨在成为通用框架和 RESTful 服务，提供基本的会话管理、身份验证、路由和数据抽象，而不包括无用的工具。APIne 的重点是让您在没有重新学习 PHP 的情况下工作。

您可以使用 APIne 的路由系统和 MVC 方法，然后使用您喜欢的 PHP 库来完成其他所有工作。

APIne 已经实现了一个综合的会话管理器、一个基本但有效的实体管理器，以及 TWIG 作为其模板管理器——足以启动任何类型的项目。

要求

对于 APIne 2

• PHP 7.2 或更高版本，并具有 PDO 扩展
• MySQL 5.6 或 MariaDB 10.1 或更高版本
• Apache 2.4 与 mod_rewrite

对于 APIne 1.1

• PHP 5.6 或更高版本，并具有 PDO 扩展
• MySQL 5.6 或 MariaDB 10.1 或更高版本
• Apache 2.4 与 mod_rewrite

使用 APIne 的项目必须安装在主机的根目录中，必须包括指令 AllowOverride FileInfo Options Indexes 以设置默认值。PHP 用户还必须在项目目录中具有写入权限。

APIne 官方不支持任何其他 HTTP 服务器（nginx、lighttpd 等）。如果您使用的是这些服务器之一，您可能需要修改服务器的配置。

安装

APIne 框架作为 Composer 包在 Packagist 上提供，也可以作为独立项目使用。

APIne 2.0 目前正在开发中，因此尚未准备好使用。建议安装框架的稳定版本。

使用 Composer

将以下行添加到您的 composer.json 文件中："youmy001/apine-framework": ^1.1"。或者输入此命令：$ composer require youmy001/apine-framework。

独立

在您的工作目录中克隆此存储库：$ git clone https://github.com/Youmy001/apine_framework.git。然后切换到最新稳定版本的分支：git checkout 1.1.x。

快速开始项目

要快速开始一个新项目，请使用位于 http://[您的项目域名]/apine-framework/install.php 的辅助工具（如果 APIne 是独立使用），或者如果您使用的是 composer 包，则使用 http://[您的项目域名]/vendor/youmy001/apine-framework/install.php，然后按照步骤操作。辅助工具将自动生成基本配置、空 locale、.htaccess 文件以及基本的 index.php，如果您使用的是独立版本，它还将自动下载 Composer 的二进制文件。

助手还将尝试导入一些对APIne操作至关重要的表格。在启动助手之前，请确保您已经创建了一个数据库，并且从项目的角度来看该数据库是可访问的。

如果您运行的是APIne的独立版本，请在通过助手后使用以下命令安装依赖项：$ php composer.phar install。

手动启动项目

首先，为了使用APIne框架，您必须将此文件复制到项目的根目录

• apine-framework/Installation/htacess_template.php

然后替换PHP标签为APIne的路径。如果您将APIne作为Composer包使用，这将将是/vendor/youmy001/apine-framework。如果您使用的是独立APIne，这可能是/apine-framework。并将文件重命名为.htaccess。

接下来，创建一个index.php文件，并在其中添加以下内容

require_once 'vendor/autoload.php'; // If APIne is a Composer package
//require_once 'apine-framework/Autoloader.php'; // If APIne is standalone

$loader = new Apine\Autoloader();
$loader->register();

$apine = new Apine\Application\Application();
$apine->set_mode(APINE_MODE_DEVELOPMENT);
$apine->run(APINE_RUNTIME_HYBRID);

最后，您需要创建一个名为config.ini的文件，该文件将包含各种配置信息。在您的配置文件中完成以下内容

[application]
title = "Project Name"
author = "Author Name"
description = "Description"
[database]
host = "localhost"
type = "mysql"
dbname = "projectdb"
charset = "utf8"
username = "root"
password = ""
[localization]
timezone_default = "America/New_York"
locale_default = "en_US"
locale_detection = "yes"
locale_cookie = "no"
[runtime]
token_lifespan = "600"
default_layout = "default"

了解更多信息

在以下链接中了解更多信息

• 文档
• 示例项目

支持

在以下链接中获取支持

• 电子邮件协助
• 问题跟踪器
• 公共Wiki

许可

APIne框架是在MIT许可下分发的。有关更多信息，请参阅LICENSE文件。