sdsdev/rest-bundle-doctrine

Symfony bundle that enables you to easily expose your Doctrine Entities via REST

Maintainers

Details

github.com/BwtSDSDevs/rest-bundle-doctrine

Source

Issues

Installs: 12

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 0

Type:symfony-bundle

0.3.7 2024-08-14 07:25 UTC

Requires

Requires (Dev)

Apache-2.0 0fba8c560856dff7275f31485b6a33fb2288c307

restdoctrine

This package is auto-updated.

Last update: 2025-03-19 10:07:39 UTC

README

Thanks to Philip Washington Sorst for the inital Project to fork from.

Updated Project to work with Doctrine ORM 3 and Symfony 7.1.*

About

This Symfony Bundle automatically generates Routes for all registered Doctrine ORM Entities.

It generates get, search, update, insert and delete routes.

Install

Install via composer

composer require sdsdev/rest-bundle-doctrine

Enable the Bundle in the config/bundles.php file of your Symfony project:

return [
    ...
    SdsDev\RestBundleDoctrine\DdrRestBundle::class => ['all' => true]
];

Register the routes in the config/routes.xml file of your Symfony project:

<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/routing
https://symfony.com/schema/routing/routing-1.0.xsd">
...
    <import resource="." type="rest_json"/>
</routes>

Authentication

To enable the default Symfony #[CurrentUser] Authentication on all endpoints do the flowing steps:

  • Create new folder in config/ called doctrineRest
  • Create a new yaml file in config/doctrineRest called doctrine_rest_auth.yaml
  • Add the following below to config/doctrineRest/doctrine_rest_auth.yaml
auth:
  true

This will enable the basic Symfony auth on all endpoints so they can only be accessed if you are logged in.

Symfony Security Docs

Usage

After fully installing there should be routes available for all entities that are registered in the Doctrine ORM

Routes will return or take data in JSON format.

If you want to see a list of all routes use:

bin/console debug:router

The entityName is the name of your entity in lowercase so UserRole would be userrole

Search

    /api/doctrine/search/{entityName}

Method: POST

Request Options

Body Schema

{
    "associations":[
        "...",
        "..."
    ],
    "filter":[
        {
            "type": "equals",
            "field": "id",
            "value": 1
        }
    ],
    "sort":[
        {
            "field": "id",
            "order": "ASC"
        }
    ],
    "page": 2
}

Associations

You can freely add associations that will be loaded with the requested entity.

Associations need to be given in snake case and as a string.

Associations can be up to 2 paths deep.

Example:

User has a connected Table UserRole and we want to load it.

Our Body would look like this:

{
    "associations":[
        "user_role"
    ]
}
Nested associations

For nested associations you can chain them with entity.entity

e.g. if UserRoles had a connected Table permissions and we want to load them too

Our Body would look like this:

{
    "associations":[
        "user_role.permissions"
    ]
}

Filter

Available Filters

  • equals
  • not_equals
  • gt (greater than)
  • lt (less than)

To get for e.x. a User with the id 1 our body would look like this

Our Body would look like this:

{
    "filter":[
        {
            "type": "equals",
            "field": "id",
            "value": 1
        }
    ],
}

If we want to filter for a User with a specific Role we can also do that

{
    "filter":[
        {
            "type": "equals",
            "field": "userRole.id",
            "value": 1
        }
    ],
}

This will return all users that have the UserRole with id 1.

If we want to load and filter the association simultaneously we can give the filter a mode parameter.

As of writing this doc only "mode": "full" is supported everything else will not have any impact.

So if we want to get a User that has the UserRole id 1 and the corresponding UserRole our Body looks like this:

{
    "associations":[
        "user_role"
    ],
    "filter":[
        {
            "type": "equals",
            "field": "userRole.id",
            "value": 1,
            "mode": "full"
        }
    ],
}

If we want to get all UserRoles but still only Users with the UserRole.id 1 we can just remove the "mode":"full" parameter.

Sorting

We can define sortings to our entities by giving the request body a sort array.

Sample Body

{
    "sort":[
        {
            "field": "id",
            "order": "ASC"
        }
    ]
}

Available sort orders

  • ASC
  • DESC

Pagination

Pagination is enabled by default (page: 1, perPage: 50) To control Pagination you can pass page and perPage in your request body.

{
    "page": 1,
    "perPage": 20
}

Get

    /api/doctrine/get/{entityName}/{id}

Method: GET

Returns an Entity with the given name and id.

Get can also use Associations see Associations above.

Insert

    /api/doctrine/insert/{entityName}

Method: POST

Body is a JSON representation of the object that you want to create.

If we assume you have a User Entity User has id, name, username, additionalName, a Country (ManyToOne Entity) and we got a country with id 1 in there.

Your Body to insert a new User would look like this

{
    "id": 1,
    "name": "Test User",
    "username": "TestAccount",
    "additionalName": null,
    "country": 1
}

(If id is autoincrement you have to delete the "id" field in the json)

If a mandatory foreign key is not set the api will return an Error!

Returns 201 if successful

Update

    /api/doctrine/update/{entityName}/{id}

Method: PUT/PATCH

If we assume you have a User Entity User has id, name, username and we want to update the username

Your Body to update would look like this

{
    "username": "New User Name"
}

Returns 200 if successful

Delete

    /api/doctrine/delete/{entityName}/{id}

Method: DELETE

Deletes an entity with the given id.

Will return an Error if the id does not exist.

Returns 204 if successful