Разработка REST API на PHP: фреймворки и примеры

Расширенные примеры создания API на PHP

Пример 1: CRUD с использованием Slim и PDO

Реализуем endpoints для работы с таблицей products через PDO. Для наглядности используем SQLite.

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

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

$db = new PDO('sqlite:db.sqlite');
$db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
$db->exec('CREATE TABLE IF NOT EXISTS products (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, price REAL)');

$app = AppFactory::create();

// Получение всех товаров
$app->get('/api/products', function (Request $request, Response $response) use ($db) {
    $stmt = $db->query('SELECT * FROM products');
    $products = $stmt->fetchAll(PDO::FETCH_ASSOC);
    $payload = json_encode($products);
    $response->getBody()->write($payload);
    return $response->withHeader('Content-Type', 'application/json');
});

// Создание товара
$app->post('/api/products', function (Request $request, Response $response) use ($db) {
    $data = $request->getParsedBody();
    $stmt = $db->prepare('INSERT INTO products (name, price) VALUES (?, ?)');
    $stmt->execute([$data['name'], $data['price']]);
    $id = $db->lastInsertId();
    $product = ['id' => (int)$id, 'name' => $data['name'], 'price' => (float)$data['price']];
    $response->getBody()->write(json_encode($product));
    return $response->withHeader('Content-Type', 'application/json')->withStatus(201);
});

// Обновление товара
$app->put('/api/products/{id}', function (Request $request, Response $response, array $args) use ($db) {
    $data = $request->getParsedBody();
    $stmt = $db->prepare('UPDATE products SET name = ?, price = ? WHERE id = ?');
    $stmt->execute([$data['name'], $data['price'], $args['id']]);
    if ($stmt->rowCount()) {
        $product = ['id' => (int)$args['id'], 'name' => $data['name'], 'price' => (float)$data['price']];
        $response->getBody()->write(json_encode($product));
        return $response->withHeader('Content-Type', 'application/json');
    }
    return $response->withStatus(404)->withBody(json_encode(['error' => 'Not found']));
});

// Удаление товара
$app->delete('/api/products/{id}', function (Request $request, Response $response, array $args) use ($db) {
    $stmt = $db->prepare('DELETE FROM products WHERE id = ?');
    $stmt->execute([$args['id']]);
    if ($stmt->rowCount()) {
        return $response->withStatus(204);
    }
    return $response->withStatus(404);
});

$app->run();

Тестирование с помощью curl:

curl -X POST http://localhost:8080/api/products -d '{"name":"Laptop","price":1500}' -H "Content-Type: application/json"
{"id":1,"name":"Laptop","price":1500}

curl http://localhost:8080/api/products
[{"id":1,"name":"Laptop","price":1500}]

Пример 2: Централизованная обработка ошибок через middleware

Создадим middleware, который перехватывает исключения и возвращает JSON с кодом ошибки.

<?php
use Slim\Factory\AppFactory;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use Slim\Psr7\Response as SlimResponse;

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

$app = AppFactory::create();

// Middleware для обработки исключений
$errorMiddleware = function (Request $request, RequestHandler $handler) {
    try {
        return $handler->handle($request);
    } catch (\Exception $e) {
        $response = new SlimResponse();
        $payload = json_encode(['error' => $e->getMessage()]);
        $response->getBody()->write($payload);
        return $response->withHeader('Content-Type', 'application/json')->withStatus(500);
    }
};

$app->add($errorMiddleware);

$app->get('/api/error', function (Request $request, Response $response) {
    throw new \Exception('Something went wrong');
});

$app->run();

Результат при запросе GET /api/error:

{"error":"Something went wrong"}

Пример 3: JWT-аутентификация с middleware

Используем библиотеку firebase/php-jwt для создания и проверки токенов. Определим middleware, который проверяет токен в заголовке Authorization.

<?php
use Firebase\JWT\JWT;
use Firebase\JWT\Key;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use Slim\Factory\AppFactory;
use Slim\Psr7\Response as SlimResponse;

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

$app = AppFactory::create();
$secretKey = 'your-secret-key';

// Middleware авторизации
$authMiddleware = function (Request $request, RequestHandler $handler) use ($secretKey) {
    $authHeader = $request->getHeaderLine('Authorization');
    if (!$authHeader || !str_starts_with($authHeader, 'Bearer ')) {
        $response = new SlimResponse();
        $response->getBody()->write(json_encode(['error' => 'Unauthorized']));
        return $response->withHeader('Content-Type', 'application/json')->withStatus(401);
    }
    $token = substr($authHeader, 7);
    try {
        $decoded = JWT::decode($token, new Key($secretKey, 'HS256'));
        $request = $request->withAttribute('user_id', $decoded->sub);
    } catch (\Exception $e) {
        $response = new SlimResponse();
        $response->getBody()->write(json_encode(['error' => 'Invalid token']));
        return $response->withHeader('Content-Type', 'application/json')->withStatus(401);
    }
    return $handler->handle($request);
};

// Маршрут для получения токена (упрощённый)
$app->post('/api/auth/login', function (Request $request, Response $response) use ($secretKey) {
    $payload = [
        'sub' => 123,
        'iat' => time(),
        'exp' => time() + 3600
    ];
    $token = JWT::encode($payload, $secretKey, 'HS256');
    $response->getBody()->write(json_encode(['token' => $token]));
    return $response->withHeader('Content-Type', 'application/json');
});

// Защищённый endpoint
$app->get('/api/profile', function (Request $request, Response $response) {
    $userId = $request->getAttribute('user_id');
    $payload = json_encode(['user_id' => $userId, 'name' => 'John']);
    $response->getBody()->write($payload);
    return $response->withHeader('Content-Type', 'application/json');
})->add($authMiddleware);

$app->run();

Результат: после вызова POST /api/auth/login получаем токен. Затем запрос GET /api/profile с заголовком Authorization: Bearer <token> возвращает данные пользователя.

curl -X POST http://localhost:8080/api/auth/login
{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."}

curl -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." http://localhost:8080/api/profile
{"user_id":123,"name":"John"}