{"id":915,"date":"2021-09-25T14:19:39","date_gmt":"2021-09-25T13:19:39","guid":{"rendered":"https:\/\/editjournal.redakt.eu\/faxmodem\/?p=915"},"modified":"2023-11-30T21:12:23","modified_gmt":"2023-11-30T21:12:23","slug":"create-rest-api-resource","status":"publish","type":"post","link":"https:\/\/editjournal.redakt.eu\/faxmodem\/blog\/development\/cakephp\/create-rest-api-resource\/","title":{"rendered":"Creating a RESTful API resource in CakePHP 4"},"content":{"rendered":"<p>CakePHP lets you convert a controller into a RESTful API resource. We will use a prefixed (in other words, namespaced) controller to prevent cluttering your main controller for that given resource.<\/p>\n<p>Using <code>$routes-&gt;setExtensions([&#039;json&#039;]);<\/code> tells the framework to parse the <code>.json<\/code> extension in the URL. Otherwise it will think it's a part of the method name.<\/p>\n<h2>CakePHP 4<\/h2>\n<ol>\n<li>\n<p>Create a prefix in <code>config\/routes.php<\/code>:<\/p>\n<pre><code>$routes->prefix('Api', function (RouteBuilder $routes) {\n    $routes->setExtensions(['json']);\n    $routes->fallbacks(DashedRoute::class);\n});<\/code><\/pre>\n<\/li>\n<li>\n<p>Create <code>src\/Controller\/Api\/AppController.php<\/code>:<\/p>\n<pre><code><?php\nnamespace App\\Controller\\Api;\n\nclass AppController extends \\App\\Controller\\AppController\n{\n\n    public function initialize(): void\n    {\n        parent::initialize();\n        $this->viewBuilder()->setOption('serialize', true);\n    }\n\n}<\/code><\/pre>\n<\/li>\n<li>\n<p>Create your resource controller, say <code>src\/Controller\/Api\/PostsController.php<\/code>:<\/p>\n<pre><code><?php\nnamespace App\\Controller\\Api;\n\nclass PostsController extends AppController\n{\n\n    public function hello() {\n        $this->set([\n            'foo' => 'bar',\n        ]);\n    }\n\n}<\/code><\/pre>\n<\/li>\n<li>\n<p>Optional: Configure your API scope in <code>config\/routes.php<\/code>:<\/p>\n<pre><code>$routes->scope('\/api', function (RouteBuilder $builder) {\n    $builder->setRouteClass(DashedRoute::class);\n    $builder->setExtensions(['json']);\n    $builder->resources('Events', [\n        'prefix' => 'Api',\n    ]);\n});<\/code><\/pre>\n<\/li>\n<\/ol>\n<h2>CakePHP 5<\/h2>\n<ol>\n<li>\n<p>Create a prefix in <code>config\/routes.php<\/code>:<\/p>\n<pre><code>$routes->prefix('Api', function (RouteBuilder $routes) {\n    $routes->setExtensions(['json']);\n    $routes->fallbacks(DashedRoute::class);\n});<\/code><\/pre>\n<\/li>\n<li>\n<p>Create <code>src\/Controller\/Api\/AppController.php<\/code>:<\/p>\n<pre><code><?php\nnamespace App\\Controller\\Api;\n\nclass AppController extends \\App\\Controller\\AppController\n{\n\n    public function initialize(): void\n    {\n        parent::initialize();\n        $this->addViewClasses([\\Cake\\View\\JsonView::class]);\n        $this->viewBuilder()->setOption('serialize', true);\n    }\n\n}<\/code><\/pre>\n<\/li>\n<li>\n<p>Create your resource controller, say <code>src\/Controller\/Api\/PostsController.php<\/code>:<\/p>\n<pre><code><?php\ndeclare(strict_types=1);\n\nnamespace App\\Controller\\Api;\n\nclass PostsController extends AppController\n{\n\n    public function hello()\n    {\n        $this->set([\n            'foo' => 'bar',\n        ]);\n    }\n\n}<\/code><\/pre>\n<\/li>\n<\/ol>\n<p>Try accessing your resource at <code>example.com\/api\/posts\/hello.json<\/code>.<\/p>\n<p>If something doesn't work right away, always run <code>bin\/cake cache clear_all<\/code> before you spend hours investigating.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Here&#8217;s how to quickly convert a controller into an API resource<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1047],"tags":[745,715,1053],"class_list":["post-915","post","type-post","status-publish","format-standard","hentry","category-cakephp","tag-api","tag-cakephp","tag-rest","entry"],"_links":{"self":[{"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/posts\/915","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/comments?post=915"}],"version-history":[{"count":13,"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/posts\/915\/revisions"}],"predecessor-version":[{"id":1536,"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/posts\/915\/revisions\/1536"}],"wp:attachment":[{"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/media?parent=915"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/categories?post=915"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/editjournal.redakt.eu\/faxmodem\/wp-json\/wp\/v2\/tags?post=915"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}