README

violines/rest-bundle 是一个用于创建 REST API 的 Symfony Bundle。它侧重于 HTTP 标准，并集成了 symfony/serializer 和 symfony/validator。

特性

• 将请求体或查询字符串转换为对象
• 从对象构建响应
• 可配置的内容协商
• 事件以控制 symfony/serializer 上下文
• symfony/validator 的集成
• 错误处理
• 可选日志记录

兼容性...

• Symfony 5.4 + 6
• PHP 8 + 8.1

设计用于...

应用领域驱动设计原则、六角架构或类似概念的现代架构。

安装

composer require violines/rest-bundle

如何工作？

1. 创建任何 PHP 类（实体、DTO、命令、查询等），并添加 #[HttpApi] 属性或 @HttpApi 注解
2. 使用 symfony/serializer 或 symfony/validator 的任何属性属性/注解
3. 将此 PHP 类声明为控制器参数的类型
4. 在控制器中返回此 PHP 类的实例

示例

在以下位置查找使用示例： https://github.com/violines/rest-bundle-showcase。

示例

<?php

declare(strict_types=1);

namespace App\Entity;

#[Violines\RestBundle\HttpApi\HttpApi]
final class Order
{
    public $amount;
    public $articles;
}

// Or use Doctrine Annotations (requires separate install):
// In order to use Annotations you have to install `doctrine/annotations` via `composer require doctrine/annotations`

/**
 * @Violines\RestBundle\HttpApi\HttpApi
 */
final class Order {}

<?php

declare(strict_types=1);

namespace App\Controller;

use App\Exception\AuthenticationFailedException;
use App\Entity\Order;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class OrderController
{
    /**
     * @return Order[]
     */
    #[Route('/orders', methods: ['GET'], name: 'find_orders')]
    public function findOrders(): array
    {
        return $this->orderRepository->findOrders();
    }

    #[Route('/order/{id}', methods: ['GET'], name: 'find_order')]
    public function findOrder(int $id): Order
    {
        $order = $this->orderRepository->find($id);

        if (null === $order) {
            throw NotFoundException::id($id);
        }

        return $order;
    }

    /**
     * @param Order[] $orders
     */
    #[Route('/orders/create', methods: ['POST'], name: 'create_orders')]
    public function createOrders(Order ...$orders): Response
    {
        $this->orderRepository->createOrders($orders);

        return new Response(null, Response::HTTP_CREATED);
    }

    #[Route('/order/create', methods: ['POST'], name: 'create_order')]
    public function createOrder(Order $order): Response
    {
        $this->orderRepository->create($order);

        return new Response(null, Response::HTTP_CREATED);
    }
}

Wiki

有关更多详细信息，请参阅 violines/rest-bundle Wiki。

开发设置

1. 将 docker/.env.dist 复制到 docker/.env 并根据需要调整
2. cd docker/
3. 拉取最新镜像：docker-compose pull
4. 创建容器：docker-compose up -d
5. 使用 docker-compose exec php80 composer run test 运行测试