mind2minds/cakephp-rest-api

CakePHP 3 plugin for building REST API services

1.0.2 2018-06-19 12:31 UTC

Requires

• cakephp/cakephp: ^3.4

Requires (Dev)

• phpunit/phpunit: ^5.7|^6.0

MIT

• mind2minds
• Community

README

This plugin is used to create REST API endpoints.

Requirements

This plugin has the following requirements:

• CakePHP 3.0.0 or greater.
• PHP 5.4.16 or greater.

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require mind2minds/cakephp-rest-api

After installation, Load the plugin

Plugin::load('RestApi', ['bootstrap' => true]);

Or, you can load the plugin using the shell command

$ bin/cake plugin load -b RestApi

Usage

You just need to create your API related controller and extend it to RestApi\Controller\AppController instead of default AppController.

namespace App\Controller;

use RestApi\Controller\AppController;

/**
 * Demo Controller
 */
class DemoController extends AppController
{

    /**
     * Read contacts or single contact details when id given
     */
    public function contacts($id = null)
    {
        $contacts = [
            //...
        ];
        $result = [];
        if(!empty($id)) {
            if (empty($contacts[$id])) {
                $this->_error(404, 'Missing Contacts', 'Invalid Id Supplied');
            } else {
                $contact = $contacts[$id];
                $result = [
                    'Id' => $id,
                    'type' => 'Contact',
                    '_name' => $contact['name'],
                    '_email' => $contact['email']
                ];
            }
        } else {
            foreach ($contacts as $id => $contact) {
                $result[] = [
                    'Id' => $id,
                    'type' => 'Contact',
                    '_name' => $contact['name'],
                    '_email' => $contact['email']
                ];
            }
        }
        $this->_createJsonApiResponse($result);
    }
}

You can define your logic in your action function as per your need. For above example, you will get following response in json format (json response as per jsonapi specs),

{
  "data": {
    "type": "contacts",
    "id": "1",
    "attributes": {
      // ... this contact's attributes
    },
    "relationships": {
      // ... this contact's relationships if any
    }
  }
}

The URL for above example will be http://yourdomain.com/api/contacts. You can customize it by setting the routes in APP/config/routes.php. Endpoint /api/contacts example is

$routes->connect('/api/contacts', ['plugin' => 'RestApi', 'controller' => 'Demo', 'action' => 'contacts']);

Accept basic http authentication header e.g. Basic NzQxZjNhOTctZTBjNC00OTFjLWI3MDItY2JlYTA5NzVmODhl this is for default demo api key

Its easy to use :)

Reporting Issues

If you have a problem with this plugin or any bug, please open an issue on GitHub.