dimkinthepro/http-bundle

Request validation bundle for Symfony

1.0.0 2024-09-04 16:26 UTC

Requires

• php: >=8.2
• symfony/dotenv: ^6 || ^7
• symfony/framework-bundle: ^6 || ^7
• symfony/validator: ^6 || ^7
• symfony/yaml: ^6 || ^7

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.26
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.3
• squizlabs/php_codesniffer: dev-master

MIT

• symfony
• http
• bundle
• validation
• request

README

1. Installation:

composer require dimkinthepro/http-bundle

2. Check bundles config:

# config/bundles.php

return [
#...
    Dimkinthepro\Http\DimkintheproHttpBundle::class => ['all' => true],
];

3. Create bundle configuration:

# config/packages/dimkinthepro_http.yaml

dimkinthepro_http:
    request_validation_enabled: true
    extra_fields_allowed: true
    handle_validation_errors: true
    response_error_format: json

4. Check validator config:

# config/packages/validator.yaml

framework:
    #...
    validation:
        #...
        mapping:
            paths:
                #...
                - '%kernel.project_dir%/config/validator/'

5. Create a controller DTO:

# src/App/DTO/RequestDTO.php

namespace App\DTO;

use Dimkinthepro\Http\Domain\DTO\ValidatedDTOInterface;

class RequestDTO implements ValidatedDTOInterface
{
    public string $method;
    public int $parameter;
    public \DateTimeImmutable $date;
    public App\Enum\FooEnum $enum;
}

6. Create a validation config for DTO:

# config/validator/RequestDTO.yaml

App\DTO\RequestDTO:
  properties:
    method:
      - NotBlank: ~
    parameter:
      - NotBlank: ~
      - GreaterThan: 0
      - LessThanOrEqual: 255
    date:
      - NotBlank: ~
    enum:
      - NotBlank: ~

7. Use validated DTO in your controller:

# src/App/Controller/Controller.php

namespace App\Controller;

use App\DTO\RequestDTO;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;

class Controller extends AbstractController
{
    public function __invoke(RequestDTO $DTO): JsonResponse
    {
        return new JsonResponse([
            'method' => $DTO->method,
            'parameter' => $DTO->parameter,
            'date' => $DTO->date,
            'enum' => $DTO->enum->value,
        ]);
    }
}