rfrommherz/api

Symfony api simplifier

1.0.0 2021-12-29 00:36 UTC

Requires

• php: >=8.0
• doctrine/annotations: ^1.13
• ramsey/uuid: ^4.2
• symfony/serializer: 5.3.*
• symfony/validator: 5.3.*
• symfony/yaml: 5.3.*

MIT

• symfony
• rest
• api
• symfony5

README

Installation

1. composer req rfrommherz/api
2. config/bundles.php: Add new bundle to bundles.php

Rf\ApiBundle\JwtBundle::class => ['dev' => true],

Usage

ApiDto

ApiDto's can be used as parameters in your controllers. To enable the support for this, your class must extend ApiDto. Each ApiDto is passed to the symfony validator, which enables the support for validation annotations.

use Rf\ApiBundle\Dto\ApiDto;
use Symfony\Component\Validator\Constraints as Assert;

class Fetch extends ApiDto
{
    /**
     * @Assert\NotBlank
     * @Assert\Url
     * @var string
     */
    private string $repositoryUrl;

Arguments will be automatically resolved and can be passed as controller arguments.

public function index(Fetch $fetch): Response
{
    ...
}

curl --location --request GET 'http://localhost/fetch' \
--header 'Content-Type: application/json' \
--data-raw '{
    "repositoryUrl": "http://...",
}'