korditpteltd/kd-cakephp-restful

KORDIT CakePHP Restful Plugin

dev-master 2020-03-31 08:37 UTC

This package is auto-updated.

Last update: 2022-04-29 01:07:02 UTC


README

Version

KORDIT CakePHP V3 Restful Plugin.

Requirements

The master branch has the following requirements:

  • CakePHP
  • PHP

Installation

Install this plugin using composer from your CakePHP V3 Project ROOT directory (where the composer.json file is located).

  • Edit composer.json file by adding the following lines:
"repositories":[
        {
            "type": "git",
            "url": "git@github.com:mohamednizar/kd-cakephp-restful.git"
        }
    ]
  • Example composer.json after adding required lines:
{
    "name": "korditpteltd/openemis-phpoe",
    "description": "KORDIT OpenEMIS CORE",
    "homepage": "https://demo.openemis.org/core",
    "type": "project",
    "license": "GPL-2.0",
    "require": {
        "php": ">=5.4.16",
        "cakephp/cakephp": "3.2.6"
    },
    "scripts": {
        "post-install-cmd": "App\\Console\\Installer::postInstall",
        "post-autoload-dump": "Cake\\Composer\\Installer\\PluginInstaller::postAutoloadDump"
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "repositories":[
        {
            "type": "git",
            "url": "git@github.com:mohamednizar/kd-cakephp-restful.git"
        }
    ]
}
  • If composer is not installed globally, issue the following command on console/terminal:
php composer.phar require korditpteltd/kd-cakephp-restful "*"
  • If composer is installed globally, issue the following command instead:
composer require korditpteltd/kd-cakephp-restful "*"

Configuration

  • Load this plugin by adding the following line in your application bootstrap.php file.
Plugin::load('Restful', ['bootstrap' => true, 'routes' => true, 'autoload' => true]);

** boostrap parameter is set to true so that this package bootstrap file will be loaded during the application life-cycle boot up process. ** This package's boostrap.php will then include its routes configurations.

Usage

After configuration was done, go to the plugin documentation from your application url to read more.

http://<your-domain-name>/restful/doc
or
https://<your-domain-name>/restful/doc