Jacwright RESTServer 技术文档

1. 安装指南

在开始使用 Jacwright RESTServer 之前，请确保您的服务器环境满足以下要求：

• PHP 5.3 或以上版本
• 开启 URL 重写模块
• 开启 APC 或其他缓存（可选，用于提高生产环境下的性能）

安装步骤如下：

1. 将 RESTServer 类文件下载到您的服务器。
2. 创建一个 index.php 文件并引入 RESTServer 类。
3. 设置 URL 重写规则，将所有请求重定向到 index.php。

以下是 .htaccess 文件的一个示例：

DirectoryIndex index.php
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteRule ^$ index.php [QSA,L]
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule ^(.*)$ index.php [QSA,L]
</IfModule>

2. 项目的使用说明

项目的核心是 RestServer 类，您可以通过它来添加控制器类并处理请求。控制器类需要定义 @url 注解来映射 URL 和方法。

以下是一个简单的控制器类示例：

class TestController
{
    /**
     * 返回一个 JSON 字符串
     *
     * @url GET /
     */
    public function test()
    {
        return "Hello World";
    }
}

您需要在 index.php 文件中添加控制器类：

$server = new RestServer($mode);
$server->addClass('TestController');
$server->handle();

3. 项目API使用文档

API 使用基于 URL 的请求来调用不同的方法。以下是控制器类中方法的 URL 映射示例：

• GET / 映射到 TestController 的 test 方法
• POST /login 映射到 TestController 的 login 方法
• GET /users/{id} 映射到 TestController 的 getUser 方法，其中 {id} 是路径参数
• POST /users 和 PUT /users/{id} 映射到 TestController 的 saveUser 方法

每个方法都支持 JSON 格式的请求体。

4. 项目安装方式

项目安装方式与上述安装指南相同。请确保按照以下步骤操作：

1. 将 RESTServer 类文件和您的控制器类文件上传到服务器。
2. 创建 index.php 文件并引入 RESTServer 类。
3. 设置 URL 重写规则以重定向到 index.php。
4. 根据需要配置控制器类和方法。

确保您的控制器类和方法按照 RESTServer 的要求使用了 @url 注解。在开发环境中，您可以自由地测试和修改代码。在生产环境中，请使用缓存以提高性能。