How to create rest service?

I create configuration in routing.yml

YAML

oro_campaign_bundle_api: resource: "@RriDesignerToolsBundle/Resources/config/oro/routing_api.yml" type: rest prefix: api/rest/{version} requirements: version: latest|v1 defaults: version: latest

1 2 3 4 5 6 7 8

oro_campaign_bundle_api:     resource:     "@RriDesignerToolsBundle/Resources/config/oro/routing_api.yml"     type:         rest     prefix:       api/rest/{version}     requirements:         version:  latest|v1     defaults:         version:  latest

and create routing_api.yml like :

YAML

oro_api_designer_tool: resource: '@RriDesignerToolsBundle/Controller/Api/Rest/DTRestController.php' type: rest

1 2 3

oro_api_designer_tool:     resource: '@RriDesignerToolsBundle/Controller/Api/Rest/DTRestController.php'     type: rest

my DTRestController is like:

PHP

<?php namespace Rri\Bundle\DesignerToolsBundle\Controller\Api\Rest; use FOS\RestBundle\Controller\Annotations\Delete; use FOS\RestBundle\Controller\Annotations\Get; use FOS\RestBundle\Controller\Annotations\NamePrefix; use FOS\RestBundle\Controller\Annotations\QueryParam; use FOS\RestBundle\Controller\Annotations\RouteResource; use Nelmio\ApiDocBundle\Annotation\ApiDoc; use Oro\Bundle\EmailBundle\Cache\EmailCacheManager; use Oro\Bundle\EmailBundle\Entity\Email; use Oro\Bundle\EmailBundle\Entity\Manager\EmailApiEntityManager; use Oro\Bundle\SecurityBundle\Annotation\AclAncestor; use Oro\Bundle\SoapBundle\Controller\Api\Rest\RestController; use Oro\Bundle\SoapBundle\Entity\Manager\ApiEntityManager; use Oro\Bundle\SoapBundle\Form\Handler\ApiFormHandler; use Oro\Bundle\SoapBundle\Request\Parameters\Filter\StringToArrayParameterFilter; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; /** * @RouteResource("designertool") * @NamePrefix("oro_api_") */ class DTRestController extends RestController { /** * @param int $id Logo id * @ApiDoc( * description="Get logos", * resource=true * ) * @Get(requirements={"id"="\d+"}) * * @return \Symfony\Component\HttpFoundation\Response */ public function getAction($id) { return ['aa','xx','cc']; } /** * Get entity Manager * * @return ApiEntityManager */ public function getManager() { return $this->get('oro_product.brand.manager.api'); } /** * @return ApiFormHandler */ public function getForm() { throw new \BadMethodCallException('Form is not available.'); } /** * @return ApiFormHandler */ public function getFormHandler() { throw new \BadMethodCallException('Form handler is not available.'); } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

<?php   namespace Rri\Bundle\DesignerToolsBundle\Controller\Api\Rest;   use FOS\RestBundle\Controller\Annotations\Delete; use FOS\RestBundle\Controller\Annotations\Get; use FOS\RestBundle\Controller\Annotations\NamePrefix; use FOS\RestBundle\Controller\Annotations\QueryParam; use FOS\RestBundle\Controller\Annotations\RouteResource; use Nelmio\ApiDocBundle\Annotation\ApiDoc; use Oro\Bundle\EmailBundle\Cache\EmailCacheManager; use Oro\Bundle\EmailBundle\Entity\Email; use Oro\Bundle\EmailBundle\Entity\Manager\EmailApiEntityManager; use Oro\Bundle\SecurityBundle\Annotation\AclAncestor; use Oro\Bundle\SoapBundle\Controller\Api\Rest\RestController; use Oro\Bundle\SoapBundle\Entity\Manager\ApiEntityManager; use Oro\Bundle\SoapBundle\Form\Handler\ApiFormHandler; use Oro\Bundle\SoapBundle\Request\Parameters\Filter\StringToArrayParameterFilter; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response;   /** * @RouteResource("designertool") * @NamePrefix("oro_api_") */ class DTRestController extends RestController {       /**      * @param int $id Logo id      * @ApiDoc(      *     description="Get logos",      *     resource=true      * )      * @Get(requirements={"id"="\d+"})      *      * @return \Symfony\Component\HttpFoundation\Response      */     public function getAction($id)     {         return ['aa','xx','cc'];     }             /**      * Get entity Manager      *      * @return ApiEntityManager      */     public function getManager()     {         return $this->get('oro_product.brand.manager.api');     }       /**      * @return ApiFormHandler      */     public function getForm()     {         throw new \BadMethodCallException('Form is not available.');     }       /**      * @return ApiFormHandler      */     public function getFormHandler()     {         throw new \BadMethodCallException('Form handler is not available.');     } }

but I can not even test my new rest service , can someone help me , how can I create a useful rest service in orocommerce , the oro version I used is 3.0

Topic

[Andrey YatsenkoModerator]

Hi, warrenpu.

It’s recommended to use the JSON.API for creating REST services.

The API you are trying to extend is deprecated and it’s not recommended to create new resources there.

Here is the usage documentation for JSON.API

And the developer documentation

Enabling JSON.API for the new Entity can be done just by adding several lines to the configuration, see
https://github.com/oroinc/platform/blob/3.0/src/Oro/Bundle/ApiBundle/Resources/doc/configuration.md#overview

[warrenpuParticipant]

Hi Andrey , thank you for your help so much.

[warrenpuParticipant]

mark it

[Author]

Replies