Api views

Hi guys,

I want to make available an “apiDoc” view, with only some specific routes (not all of them).
This view will be available only for a few clients.

I know that is easy to create a new view with Nelmio, but because of the Oro overriding i’m not sure how to do it properly.

Indeed, i see that there is some class to generate the filters, documentations, etc.. dynamically, but these classes seem to be linked with the “rest_json_api” view!
Furthermore, the routes are also handle dynamically.

So, is there a way to add a new JsonApi view easily? with only some specific entities ?

Thanks by advance.

Topic

[Mike KudelyaParticipant]

Hi

I have created this controller action with two routes and connect it to nelmio template. Here is action:

PHP

/** * @Route("/doc", name="custom_api_view") * @Template */ public function docAction() { $accountRoute = $this->get('router')->getRouteCollection()->get('oro_api_get_accounts'); $contactRoute = $this->get('router')->getRouteCollection()->get('oro_api_get_contacts'); $extractedDoc = $this ->get('nelmio_api_doc.extractor.api_doc_extractor') ->extractAnnotations([$accountRoute, $contactRoute], ApiDoc::DEFAULT_VIEW); $htmlContent = $this->get('nelmio_api_doc.formatter.html_formatter')->format($extractedDoc); return new Response($htmlContent, 200, array('Content-Type' => 'text/html')); }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

/**      * @Route("/doc", name="custom_api_view")      * @Template      */     public function docAction()     {         $accountRoute = $this->get('router')->getRouteCollection()->get('oro_api_get_accounts');         $contactRoute = $this->get('router')->getRouteCollection()->get('oro_api_get_contacts');           $extractedDoc = $this             ->get('nelmio_api_doc.extractor.api_doc_extractor')             ->extractAnnotations([$accountRoute, $contactRoute], ApiDoc::DEFAULT_VIEW);         $htmlContent  = $this->get('nelmio_api_doc.formatter.html_formatter')->format($extractedDoc);           return new Response($htmlContent, 200, array('Content-Type' => 'text/html'));     }

Nelmio template you can find there, just copy it or extend: vendor/nelmio/api-doc-bundle/Nelmio/ApiDocBundle/Resources/views/layout.html.twig

[Author]

Replies