Slim Framework 技术文档

1. 安装指南

1.1 环境要求

• PHP 7.4 或更高版本

1.2 使用 Composer 安装

推荐使用 Composer 来安装 Slim Framework。

$ composer require slim/slim

此命令将安装 Slim 及其所有必需的依赖项。

1.3 选择 PSR-7 实现

在开始使用 Slim 之前，您需要选择一个 PSR-7 实现。以下是一些推荐的实现：

• Slim-Psr7：Slim Framework 的 PSR-7 实现
• httpsoft/http-message 和 httpsoft/http-server-request：最快的、最严格的、最轻量级的实现
• Nyholm/psr7 和 Nyholm/psr7-server：性能与 HttpSoft 实现几乎相同
• Guzzle/psr7：Guzzle 客户端使用的实现，具有额外的流和文件处理功能
• laminas-diactoros：Laminas (Zend) 的 PSR-7 实现

1.4 安装 Slim-Http 装饰器

Slim-Http 是一组用于任何 PSR-7 实现的装饰器，推荐与 Slim Framework 一起使用。

composer require slim/http

1.5 关闭自动装饰器检测

如果您安装了 Slim-Http 并希望关闭自动对象装饰，可以使用以下代码：

<?php
use Slim\Factory\AppFactory;
use Slim\Factory\ServerRequestCreatorFactory;

AppFactory::setSlimHttpDecoratorsAutomaticDetection(false);
ServerRequestCreatorFactory::setSlimHttpDecoratorsAutomaticDetection(false);

$app = AppFactory::create();

// ...

2. 项目的使用说明

2.1 Hello World 示例

以下是一个简单的 Hello World 示例，展示了如何使用 AppFactory 和 PSR-7 自动检测功能。

<?php
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Slim\Factory\AppFactory;

require __DIR__ . '/../vendor/autoload.php';

// 实例化 App
$app = AppFactory::create();

// 添加错误中间件
$app->addErrorMiddleware(true, true, true);

// 添加路由
$app->get('/', function (Request $request, Response $response) {
    $response->getBody()->write('<a href="/hello/world">Try /hello/world</a>');
    return $response;
});

$app->get('/hello/{name}', function (Request $request, Response $response, $args) {
    $name = $args['name'];
    $response->getBody()->write("Hello, $name");
    return $response;
});

$app->run();

2.2 使用内置 PHP 服务器测试

您可以使用内置的 PHP 服务器快速测试应用程序：

$ php -S localhost:8000 -t public

访问 http://localhost:8000/hello/world 将显示 "Hello, world"。

3. 项目 API 使用文档

3.1 路由定义

Slim 提供了多种路由定义方法，包括 GET、POST、PUT、DELETE 等。

$app->get('/', function (Request $request, Response $response) {
    $response->getBody()->write("Hello, World");
    return $response;
});

$app->post('/submit', function (Request $request, Response $response) {
    $data = $request->getParsedBody();
    $response->getBody()->write("Received data");
    return $response;
});

3.2 中间件

Slim 支持中间件，可以在请求和响应之间添加自定义逻辑。

$app->add(function (Request $request, RequestHandler $handler) {
    $response = $handler->handle($request);
    $response->getBody()->write(' AFTER');
    return $response;
});

4. 项目安装方式

4.1 通过 Composer 安装

$ composer require slim/slim

4.2 选择 PSR-7 实现

根据您的需求选择合适的 PSR-7 实现，并使用 Composer 安装。

4.3 安装 Slim-Http 装饰器

composer require slim/http

4.4 关闭自动装饰器检测

如果需要关闭自动装饰器检测，请参考 1.5 节的内容。

通过以上步骤，您可以成功安装并开始使用 Slim Framework 来构建强大的 Web 应用程序和 API。