Skip to content

Latest commit

 

History

History
357 lines (305 loc) · 9.94 KB

README.md

File metadata and controls

357 lines (305 loc) · 9.94 KB
Raw

Latest Stable Version test workflow License: MIT Total Downloads

JsonApiBundle For Symfony

JsonApiBundle is a Symfony bundle. It is the fastest way to generate API based on JsonApi using woohoolabs/yin Library.

Installing

  1. Install symfony

    composer create-project symfony/skeleton YOUR_PROJECT

  2. Install the maker bundle

    composer require symfony/maker-bundle phootwork/collection --dev

  3. Install the bundle

    composer require paknahad/jsonapi-bundle

    For Symfony 4 use:

    composer require paknahad/jsonapi-bundle:^3.1

  4. Add below line to config/bundles.php

    Paknahad\JsonApiBundle\JsonApiBundle::class => ['all' => true],

Usage

  1. Use below command to generate entities one by one:

    bin/console make:entity

    for example, Book and Author entity is as follows:

    use Doctrine\ORM\Mapping as ORM;
class Book
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $title;

    /**
     * @ORM\Column(type="string", length=20, nullable=true)
     */
    private $isbn;

    /**
     * @ORM\ManyToMany(targetEntity="App\Entity\Author", inversedBy="books")
     */
    private $authors;
 
    ... 
    use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255)
     * @Assert\NotBlank()
     * @Assert\Length(min=3)
     */
    private $name;

    /**
     * @ORM\ManyToMany(targetEntity="App\Entity\Book", mappedBy="authors")
     */
    private $books;
 
    ...

  2. Generate CRUD API:

    bin/console make:api

  3. You can find the generated "collections" for postman and swagger in the following path and then test the API:

    collection/postman.json
collection/swagger.yaml

Features

Pagination

http://example.com/books?page[number]=5&page[size]=30

Sorting

  • Ascending on name field: http://example.com/books?sort=name
  • Decending on name field: http://example.com/books?sort=-name
  • Multiple fields: http://example.com/books?sort=city,-name
  • Field on a relation: http://example.com/books?sort=author.name

Relationships

http://example.com/books?include=authors

multiple relationships

http://example.com/books?include=authors.phones,publishers

Search

As the JSON API specification does not specify exactly how filtering should work different methods of filtering can be used. Each method is supplied with a Finder service. Each registered Finder will be able to append conditions to the search query. If you register multiple Finders they are all active at the same time. This enables your API to support multiple filtering methods.

Basic Finder.

A basic Finder is included in this library offering simple filtering capabilities:

This request will return all the books that author's name begin with hamid

http://example.com/books?filter[authors.name]=hamid%

Below line has additional condition: books which have "php" in their title.

http://example.com/books?filter[title]=%php%&filter[authors.name]=hamid%

Setting a default filter on the IndexAction

By using $resourceCollection->getQuery() you can get access on the query object. use "r" alias for referring to the current entity. in this example the "r" refers to the "ProjectEntity"

use Symfony\Component\Routing\Annotation\Route;
class ProjectController extends Controller
{
    /**
     * @Route("/", name="projects_index", methods="GET")
     */
    public function index(ProjectRepository $projectRepository, ResourceCollection $resourceCollection): ResponseInterface
    {
        $resourceCollection->setRepository($projectRepository);

        $resourceCollection->getQuery()->where('r.user_id = :s1')->setParameter(...);
        $resourceCollection->handleIndexRequest();

        return $this->jsonApi()->respond()->ok(
            new ProjectsDocument(new ProjectResourceTransformer()),
            $resourceCollection
        );
    }

Other Finders

Currently, the following Finders are available via other bundles:

Creating a custom Finder

A Finder can be registered via a service tag in the services definition. The tag paknahad.json_api.finder must be added to the service for the Finder to be resigered.

Example:

<service class="Paknahad\JsonApiBundle\Helper\Filter\Finder" id="paknahad_json_api.helper_filter.finder">
    <tag name="paknahad.json_api.finder" />
</service>

Each Finder must implement the Paknahad\JsonApiBundle\Helper\Filter\FinderInterface interface. Take a look at \Paknahad\JsonApiBundle\Helper\Filter\Finder for an implementation example.

If you need more control over the finders, you can instead use \Paknahad\JsonApiBundle\Helper\Filter\FinderSupportsInterface interface and implement conditional logic inside supports() method:

use Paknahad\JsonApiBundle\Helper\Filter\FinderSupportsInterface;
use Paknahad\JsonApiBundle\Helper\FieldManager;
use Symfony\Component\HttpFoundation\Request;

class CustomFinder implements FinderSupportsInterface
{
    public function supports(Request $request, FieldManager $fieldManager): bool
    {
        // based on some request data
        if ($request->query->has('some-flag')) {
            return true;
        }

        // based on document field manager
        if ($fieldManager->getRootEntity() === Author::class) {
            return true;
        }

        return false;
    }
}

Validation

Error on validating associations

{
    "jsonapi": {
        "version": "1.0"
    },
    "errors": [
        {
            "detail": "Invalid value for this relation",
            "source": {
                "pointer": "/data/relationships/authors",
                "parameter": "1"
            }
        }
    ]
}

Validate attributes if you have defined validators on entities.

{
    "jsonapi": {
        "version": "1.0"
    },
    "errors": [
        {
            "detail": "This value is too short. It should have 3 characters or more.",
            "source": {
                "pointer": "/data/attributes/name",
                "parameter": "h"
            }
        }
    ]
}

Error handler

All errors such as:

  • Internal server error (500)
  • Not found (404)
  • Access denied (403)

has responses like this:

{
    "meta": {
        "code": 0,
        "message": "No route found for \"GET /book\"",
        "file": "/var/www/vendor/symfony/http-kernel/EventListener/RouterListener.php",
        "line": 139,
        "trace": [
            {
                "file": "/var/www/vendor/symfony/event-dispatcher/EventDispatcher.php",
                "line": 212,
                "function": "onKernelRequest"
            },
            {
                "file": "/var/www/vendor/symfony/event-dispatcher/EventDispatcher.php",
                "line": 44,
                "function": "doDispatch"
            },
            {
                "file": "/var/www/vendor/symfony/http-kernel/HttpKernel.php",
                "line": 125,
                "function": "dispatch"
            },
            {
                "file": "/var/www/vendor/symfony/http-kernel/HttpKernel.php",
                "line": 66,
                "function": "handleRaw"
            },
            {
                "file": "/var/www/vendor/symfony/http-kernel/Kernel.php",
                "line": 188,
                "function": "handle"
            },
            {
                "file": "/var/www/public/index.php",
                "line": 37,
                "function": "handle"
            }
        ]
    },
    "links": {
        "self": "/book"
    },
    "errors": [
        {
            "status": "404",
            "code": "NO_ROUTE_FOUND_FOR_\"GET_/BOOK\"",
            "title": "No route found for \"GET /book\""
        }
    ]
}

NOTICE: the "meta" field gets filled just on development environment.

Configuration

You can configure this bundle with following options:

#config/packages/json_api.yaml

json_api:
    documentationSchema: 'openapi'
    controllerNamespace: 'Controller'

Supported documentation schemas are openapi and swagger. If you want to generate controllers in a different namespace, for example Controller\Api you can use controllerNamespace configuration option. To prefix Api routes you can use Symfony routes configuration:

#config/routes/annotations.yaml

api:
    resource: ../../src/Controller/Api
    type: annotation
    prefix: /api