首页
/ Restler 项目技术文档

Restler 项目技术文档

2024-12-24 09:13:31作者:鲍丁臣Ursa

1. 安装指南

1.1 安装 Composer

Restler 使用 Composer 来管理依赖。首先,下载 composer.phar 文件。你可以将其放在项目文件夹中,或者理想情况下放在 usr/local/bin 中,以便全局使用。如果你使用的是 Windows 系统,可以使用 Composer 的 Windows 安装程序

1.2 安装 Restler

选项 1:使用 Composer 创建项目

你可以通过在终端中运行以下命令来安装 Restler。将 {projectName} 替换为你的实际项目名称。这将创建一个以该名称命名的文件夹并安装 Restler。

php composer.phar create-project luracast/restler {projectName}

注意:

  • 如果你不想安装额外的格式和 BDD 工具,可以在命令中添加 --no-dev 以排除开发包。
  • 如果你想尝试最新的 v3 分支或任何功能分支,可以在命令中添加 3.x-devdev-features/html

选项 2:从 GitHub 下载

安装 Composer 后,下载 Restler 框架的最新版本并将其内容解压到服务器上的一个目录中。然后,在 Restler 项目的根目录中运行 php composer.phar install(或 composer install)命令以安装所有框架依赖项。此过程需要服务器上安装 Git 才能成功完成安装。

如果你想更新 Restler 框架,可以运行 php composer.phar update 命令。

注意: 如果你无法在服务器上安装 Composer 和 Git,可以在开发机器上安装并运行它们。然后将生成的文件和文件夹上传并在服务器上使用。

1.3 配置

理想情况下,应将 public 文件夹映射为 Web 根目录。这是可选的,但建议避免暴露不必要的文件和文件夹。

1.4 测试

在本地主机上尝试实时示例。你可以使用 composer serve 命令启动 PHP 内置服务器。

1.5 运行测试

更新 behat.yml 中指定的 base_url,然后尝试以下命令:

vendor/bin/behat

或者你可以运行 composer test

2. 项目使用说明

2.1 快速开始指南

我们有两个选项来创建你自己的 Restler API 服务器:

  1. 使用应用程序模板:最方便的选项是使用应用程序模板,如 Restler Application,它集成了许多包来帮助我们处理业务逻辑。如果你选择此选项,请选择该仓库中的一个分支并按照那里的说明进行操作。

  2. 从头开始创建项目:如果你选择此选项,可以完全控制应用程序的每个方面。请按照以下步骤操作:

    • 创建一个文件夹来保存你的项目并在终端中打开它。
    • 运行 composer init 并按照提示创建 composer.json
    • 当询问依赖项时,输入 restler/framework^5 作为版本约束。
    • 或者,你可以先创建 composer.json,然后运行 composer require restler/framework:^5

注意: 我们使用 restler/framework 而不是 luracast/restler 来减少包所需的存储空间。它来自 Restler-Framework,只包含 src 文件夹的内容。

2.2 编写 API

创建你的 API 类,包含所有需要的公共和受保护方法。

2.3 打开网关

创建 网关(public/index.php),如下所示:

<?php
require_once __DIR__.'/../vendor/autoload.php';

use Luracast\Restler\Restler;

$r = new Restler();
$r->addAPIClass('YourApiClassNameHere'); // 可以重复添加更多
$r->handle(); // 提供响应

2.4 美化 URL

启用 URL 重写

确保所有请求都指向 index.php,通过启用网站的 URL 重写功能。

例如:

如果你使用的是 Apache,可以使用如下 .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>
<IfModule mod_php5.c>
    php_flag display_errors On
</IfModule>

注意: 这需要将 AllowOverride 设置为 All 而不是 None,并且可能需要在某些服务器配置上进行一些调整。

如果你使用的是 Nginx,请确保设置 server_name 并将 PHP 脚本传递给监听 127.0.0.1:9000 的 fastcgi(PHP-FPM)。

server {
    listen        80;
    server_name   api.luracast.com; // 根据你的服务器名称进行更改

    location ~ \.php$ {
        root           /var/www/html;
        fastcgi_pass   127.0.0.1:9000;
        fastcgi_index  index.php;
        fastcgi_param  SCRIPT_FILENAME  /var/www/html/$fastcgi_script_name;
        include        fastcgi_params;
    }
}

注意: 这需要正确安装 PHP 和 PHP-FPM。

3. 项目 API 使用文档

3.1 支持的 HTTP 请求方法

Restler 支持以下 HTTP 请求方法:

  • HEAD
  • GET
  • POST
  • PUT
  • DELETE
  • OPTIONS
  • PATCH

这些方法可以通过请求头或请求参数(method)来使用。

3.2 内容格式转换

Restler 支持双向格式(媒体类型)转换,包括发送和接收:

  • JSON
  • XML
  • Yaml
  • Amf
  • Plist(XML 和二进制)

3.3 认证方案

Restler 支持可插拔的认证方案,包括 OAuth 2 服务器。

3.4 过滤器

Restler 支持可插拔的过滤器,用于有效管理 API 使用,例如 API 速率限制过滤器。

3.5 路由

Restler 支持手动路由(注解)和自动路由(反射):

  • 手动路由:使用 @url GET my/custom/url/{param} PHPDoc 注释
  • 自动路由:URL 到方法的映射

3.6 缓存

Restler 内置缓存支持,包括客户端缓存和代理缓存。

3.7 API 版本控制

Restler 支持通过 URL 和供应商特定的 MIME 进行 API 版本控制。

3.8 API 文档和发现

Restler 支持使用 Restler API Explorer 进行 API 文档和发现。

4. 项目安装方式

Restler 可以通过以下两种方式安装:

  1. 使用 Composer 创建项目:通过 composer create-project 命令安装。
  2. 从 GitHub 下载:手动下载并安装依赖。

安装完成后,配置并启动项目,即可开始使用 Restler 构建 RESTful API。

热门项目推荐
相关项目推荐

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
46
37
PDFMathTranslatePDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/Docker
Python
30
3
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
171
39
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
165
34
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
249
63
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
24
17
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
892
0
RuoYi-CloudRuoYi-Cloud
🎉 基于Spring Boot、Spring Cloud & Alibaba的分布式微服务架构权限管理系统,同时提供了 Vue3 的版本
Java
25
10
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
391
102
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台,旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块,支持多种类型的测试用例,目前支持API(http和grpc协议)、性能、CI调用等功能,并且可定制化,灵活满足不同场景的需求。 其中,支持批量执行、并发执行等高级功能。通过用例设置,可以设置用例的基本信息、运行配置、环境变量等,灵活控制用例的执行。
JavaScript
11
2