vim/symfony-api

2.3.17 2022-09-25 18:21 UTC

Requires

• php: >=8
• ext-json: *
• doctrine/doctrine-bundle: *
• doctrine/orm: *
• jms/serializer-bundle: *
• sensio/framework-extra-bundle: *
• stof/doctrine-extensions-bundle: *
• symfony/config: ^5|^6
• symfony/dependency-injection: ^5|^6
• symfony/security-bundle: ^5|^6
• symfony/validator: ^5|^6

proprietary

• symfony 5
• symfony-api
• php 8
• symfony 6

README

composer require vim/symfony-api

Configuration

config/packages/api.yaml

api:
  cors:
    allow_origin: '%env(CORS_ALLOW_ORIGIN)%'
    allow_headers: 'Authorization, Content-Type'
#    allow_origin: '^https?://(localhost|127\.0\.0\.1)(:[0-9]+)?$'

api/config/bundles.php

<?php
return [
  // ...
  Vim\Api\ApiBundle::class => ['all' => true],
];

Example

<?php
declare(strict_types=1);

namespace App\Controller;

use Symfony\Component\Routing\Annotation\Route;
use Vim\Api\Attribute\Resource;
use Vim\Api\Attribute\Paginate;
use Vim\Api\Attribute\Filter;
use Vim\Api\Attribute\Hydrate;
use Vim\Api\Attribute\Validate;
use Vim\Api\Attribute\Flush;
use App\Entity\Post;

#[Route('/post')]
class PostController
{
    #[Route('')]
    #[Resource(Post::class)]
    #[Paginate]
    #[Filter\MultiSelect('category.group.id')]
    #[Filter\DateFrom('postedAt', 'postedAtFrom')]
    #[Filter\DateTo('postedAt', 'postedAtTo')]
    #[Filter\Like('content')]
    public function index(): void
    {
    }
    
    #[Route('', methods: ['POST'])]
    #[Resource('post')]
    #[Hydrate]
    #[Validate]
    #[Flush]
    public function create(Post $post): void
    {
    }

    #[Route('/{id}', methods: ['PUT'])]
    #[Resource('post')]
    #[Hydrate]
    #[Validate]
    #[Flush]
    public function update(Post $post): void
    {
    }

    #[Route('/{id}', methods: ['DELETE'])]
    #[Resource('post')]
    #[Flush]
    public function delete(Post $post): void
    {
    }
}