Download the PHP package vudp/cakephp-rest-api without Composer

On this page you can find all versions of the php package vudp/cakephp-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of vudp/cakephp-rest-api

Informations about the package cakephp-rest-api

RestApi plugin for CakePHP 4.2.2

Our packagist repo: https://packagist.org/packages/vudp/cakephp-rest-api

This plugin provides basic support for building REST API services in your CakePHP 4 application. Read a detailed guide on how to implement below.

Requirements

This plugin has the following requirements:

Installation

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

After that, you can setup our package by standing at orginal folder of your project and running

After installation, Load the plugin

Or, you can load the plugin using the shell command

The complete code of "bootstrap" function at src/Application.php where you just added your RestApi plugin.

Usage

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

Configurations

The default configurations are as below and defined in RestApi/config/api.php.

Debug

Set debug to true in your development environment to get original exception messages in response.

Response format

It supports json and xml formats. The default response format is json. Set responseType to change your response format. In case of xml format, you can set the root element name by xmlResponseRootNode parameter.

If you want to pass token in header, use below format.

In case of GET or POST parameter, pass the token in token parameter.

cors

By default, cors requests are enabled and allowed from all domains. You can overwrite these settings by creating config file at APP/config/api.php. The content of file will look like,

To disable cors request, set enabled flag to false. To allow requests from specific domains, set them in origin option like,

Log request & response

By default, request log is disabled. You can overwrite this by creating/updating config file at APP/config/api.php . The content of file will look like,

After enabling the log, you need to create a table in your database. Below is the table structure.

Or you can use the bake command to automatically generate the above table.

Response format

The default response format of API is json and its structure is defined as below.

If you have set httpResponseCode to any value other that 200, the status value will be NOK otherwise OK. In case of exceptions, it will be handled automatically and set the appropriate status code.

You can modify the default response configuration like the text for OK response, key for main response data, etc. by overwriting them in your APP/config/api.php file.

In case of xml format, the response structure will look like,

Examples

Below are few examples to understand how this plugin works.

Register API

Route: /api/register

Params

Login API

Route: /api/login

Params

Controller > AuthController to support for certificate of log-in and registration

Model > Table > UsersTable.php

Model > Entity > User.php

Routing

All versions of cakephp-rest-api with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2.0
cakephp/cakephp Version 4.*
firebase/php-jwt Version ^4.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package vudp/cakephp-rest-api contains the following files

Loading the files please wait ....