/blog/2015/04/how-to-prefix-route-a-cakephp-3-rest-api/

[bravo-kernel]

How to prefix route a CAKEPHP 3 REST API

https://www.bravo-kernel.com/blog/2015/04/how-to-prefix-route-a-cakephp-3-rest-api/

[bravo-kernel]

Sascha Müller [DISQUS]: Hello, when creating an api-prefix and copying all relevant controllers into that directory, the code won't be DRY... Or did I misunderstand sth.? E.g. I have a modules-controller. On the website I can add,edit,remove,view my modules. The add-action does some more than only add modules (e.g.). When I want to make the modules accessable via the api, I do have to make a copy of the modules-controller to the api-dir, so I have this controller twice. I understood this article like this. Is this correct and how can I prevent this? Or is the only way not to make a prefix, but a new scope "/api".
But - very great article. Works like a charm! Thanks

[bravo-kernel]

Bravo Kernel [DISQUS]: Separation of concern would be the key motivational driver for creating a prefixed namespace. If you want to prevent multiple controller files you should NOT create a prefixed route.

As mentioned in #cakephp you could setup route for '/:myprefix/:controller/:action' with ['myprefix' => 'api'] in options and then check/use request->params['myprefix'] in controller" since basically all you need is a way to differentiate an api vs no api request.

[bravo-kernel]

Bruno Santana [DISQUS]:

Problem solved!

I had created an 'api' directory, not 'Api'. ;D

Problem

Hi, I'm getting a 404 (Cocktails controller not found) when I test the routes. All other steps of this series are OK in my case. I'm trying the url http://cake3api.app/api/cocktails.json. I also tried to use a cakephp's default AppController in src/Controller/AppController.php, instead of the one present in this series. Same result. My files:

config/routes.php:

extensions(['json', 'xml']);  
    $routes->resources('Cocktails');  
});

Router::scope('/', function ($routes) {

src/Controller/api/CocktailsController.php:

'limit' => 5,  
'maxLimit' => 15,  
'sortWhitelist' => [  
    'id', 'name'  
]  

src/Controller/api/AppController.php:

[  
'actions' => [  
    'Crud.Index',  
    'Crud.View',  
    'Crud.Add',  
    'Crud.Edit',  
    'Crud.Delete'  
],  
'listeners' => [  
    'Crud.Api',  
    'Crud.ApiPagination',  
    'Crud.ApiQueryLog'  
]  

[bravo-kernel]

Bravo Kernel [DISQUS]: Good to hear, I needed to approve your comment somehow so that's why it didn't show up immediately in case you're wondering. Btw: please use gists for code examples, they are quite unreadable in disqus.

[bravo-kernel]

andrew1980uk [DISQUS]: Hi mate, thanks for the tutorial it's really good and has taught me a lot.

Quick question...

How would you go about doing multiple inserts/adds?

Say I want to add more than one row at a time.

I can see there are CRUD bulk actions for delete and update but I can't see anything for inserting.

Does the fact it wasn't added to the CRUD plugins bulk actions mean you should just fire multiple 'add' requests off via the API?

[bravo-kernel]

Bravo Kernel [DISQUS]: You could try a bulk insert using the ApiListener but I don't think it is supported. The JsonApiListener does not support it for sure because the JSON API specification currently does not support it.

[bravo-kernel]

andrew1980uk [DISQUS]: I don't think it is supported either.

So there isn't really a way to do it out of the box then?

I didn't think I would be the only one wanting to insert multiple things in one go.

A short term option might be to just fire a load off in a loop.

[bravo-kernel]

Bravo Kernel [DISQUS]: You could create a ticket at the Crud repo asking/requesting about the support for bulk-add for ApiListener, that way you will get the correct answer (not my opinionated one). JsonApiListener will not support it as long as the spec doesn't either.

[bravo-kernel]

T Hess [DISQUS]: I keep getting "Missing CSRF token cookie". I've tried so many different things from from different sorces but have not been able to get this error yto go away. I'm trying to access my CakePhp site API from another sub domain (non-Cakephp) but it gives me thie CSRF error. I'm using Cakephp 3.7. Do you have any suggest of where I can find an answer for this.

[bravo-kernel]

Bravo Kernel [DISQUS]: Try searching for CORS in one of the follow-up posts.It contains a pointer to https://github.com/ozee31/cakephp-cors.