PHP API: новый взгляд на создание веб-сервисов

Расширенные примеры разработки PHP API

Аутентификация JWT в Slim

Использование библиотеки firebase/php-jwt для создания и проверки токена.

composer require firebase/php-jwt

Пример middleware для проверки токена:

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\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

class JwtAuthMiddleware implements MiddlewareInterface
{
    public function process(Request $request, RequestHandlerInterface $handler): Response
    {
        $authHeader = $request->getHeader('Authorization');
        if (!$authHeader || !preg_match('/Bearer\s(\S+)/', $authHeader[0], $matches)) {
            $response = new \Slim\Psr7\Response(401);
            $response->getBody()->write(json_encode(['error' => 'Token not provided']));
            return $response->withHeader('Content-Type', 'application/json');
        }
        $token = $matches[1];
        try {
            $decoded = JWT::decode($token, new Key('secret-key', 'HS256'));
            $request = $request->withAttribute('user_id', $decoded->sub);
        } catch (\Exception $e) {
            $response = new \Slim\Psr7\Response(401);
            $response->getBody()->write(json_encode(['error' => 'Invalid token']));
            return $response->withHeader('Content-Type', 'application/json');
        }
        return $handler->handle($request);
    }
}

Результат запроса без токена:

HTTP/1.1 401 Unauthorized
Content-Type: application/json
{"error":"Token not provided"}

Валидация данных с помощью Respect\Validation

Библиотека позволяет задавать правила валидации. Пример проверки email и пароля:

use Respect\Validation\Validator as v;

$email = 'user@example.com';
$password = 'weak';

$emailValidator = v::email();
$passwordValidator = v::alnum()->noWhitespace()->length(8, 20);

if (!$emailValidator->validate($email)) {
    $errors[] = 'Email is invalid';
}
if (!$passwordValidator->validate($password)) {
    $errors[] = 'Password must be 8-20 alphanumeric characters';
}

Пример ответа с ошибками:

{
  "errors": ["Password must be 8-20 alphanumeric characters"]
}

Пагинация и фильтрация списка пользователей

Добавление параметров page и limit, возврат метаданных.

$app->get('/users', function (Request $request, Response $response) {
    $params = $request->getQueryParams();
    $page = max(1, (int)($params['page'] ?? 1));
    $limit = min(100, max(1, (int)($params['limit'] ?? 10)));
    $offset = ($page - 1) * $limit;

    // Пример данных из базы
    $total = 50;
    $users = [['id' => 1, 'name' => 'Alice'], ['id' => 2, 'name' => 'Bob']];

    $result = [
        'data' => $users,
        'meta' => [
            'page' => $page,
            'limit' => $limit,
            'total' => $total,
            'pages' => ceil($total / $limit)
        ]
    ];
    $response->getBody()->write(json_encode($result));
    return $response->withHeader('Content-Type', 'application/json');
});

Результат запроса /users?page=2&limit=5:

{
  "data": [ ... ],
  "meta": {
    "page": 2,
    "limit": 5,
    "total": 50,
    "pages": 10
  }
}

Загрузка файла через API

Обработка multipart/form-data, сохранение файла в директорию.

$app->post('/upload', function (Request $request, Response $response) {
    $uploadedFiles = $request->getUploadedFiles();
    $file = $uploadedFiles['file'] ?? null;
    if (!$file || $file->getError() !== UPLOAD_ERR_OK) {
        $response->getBody()->write(json_encode(['error' => 'File upload failed']));
        return $response->withStatus(400)->withHeader('Content-Type', 'application/json');
    }
    $filename = uniqid() . '_' . $file->getClientFilename();
    $file->moveTo(__DIR__ . '/uploads/' . $filename);
    $response->getBody()->write(json_encode(['filename' => $filename]));
    return $response->withHeader('Content-Type', 'application/json');
});

Результат успешной загрузки:

{
  "filename": "67890abc_photo.jpg"
}

Тестирование маршрутов с PHPUnit

Использование HTTP-клиента для тестирования Slim-приложения.

use PHPUnit\Framework\TestCase;
use Slim\Psr7\Factory\ServerRequestFactory;
use Slim\App;

class ApiTest extends TestCase
{
    public function testHelloEndpoint()
    {
        $app = (new App())->get('/hello/{name}', function ($request, $response, $args) {
            $response->getBody()->write(json_encode(['message' => "Hello, {$args['name']}"]));
            return $response->withHeader('Content-Type', 'application/json');
        });

        $request = (new ServerRequestFactory())->createServerRequest('GET', '/hello/World');
        $response = $app->handle($request);

        $this->assertEquals(200, $response->getStatusCode());
        $this->assertStringContainsString('Hello, World', (string)$response->getBody());
    }
}

Результат выполнения теста (при успехе):

OK (1 test, 2 assertions)