A skeleton for creating API focused applications with CakePHP 5.x. This application comes with the following customizations:
- JSON output is enabled. HTML rendering is discouraged.
- HTML focused middleware is not included. Sessions, CSRF, and secure cookies are not included.
- Simpler Route configuration
The framework source code can be found here: cakephp/cakephp.
- Download Composer or update
composer self-update
. - Run
php composer.phar create-project --prefer-dist cakephp/api-app [app_name]
.
If Composer is installed globally, run
composer create-project --prefer-dist cakephp/api-app
In case you want to use a custom app dir name (e.g. /myapp/
):
composer create-project --prefer-dist cakephp/api-app myapp
You can now either use your machine's webserver to view the default home page, or start up the built-in webserver with:
bin/cake server -p 8765
Then visit http://localhost:8765
to see the welcome page.
Since this skeleton is a starting point for your application and various files would have been modified as per your needs, there isn't a way to provide automated upgrades, so you have to do any updates manually.
Read and edit the environment specific config/app_local.php
and set up the
'Datasources'
and any other configuration relevant for your application.
Other environment agnostic settings can be changed in config/app.php
.