README.md

RestApi module for Zend Framework 3

Requirements

This module has the following requirements:

• Zend Framework 3 or greater.
• PHP 7 or greater.

Installation

You can install this module into your Zend Framework application using composer.

The recommended way to install composer packages is:

composer require multidots/zf3-rest-api

Now copy this file "vender/multidots/zf3-rest-api/config/restapi.global.php" and paste to root "config/autoload/restapi.global.php"

If you do not setup at the time of package installation then add this 'RestApi' to modules.config.php file.

return [
    ....
    //add this if not available
    'RestApi'
];

Usage

You just need to create your API related controller and extend it to ApiController instead of default AbstractActionController. You just need to return your results with $this->createResponse($apiResponse). For example,

namespace Application\Controller;

use RestApi\Controller\ApiController;

/**
 * Foo Controller
 */
class FooController extends ApiController
{

    /**
     * bar method
     *
     */
    public function barAction()
    {
        // Generate your response
        $response[
            'you_response' => 'your response data';
        ];

        return $this->createResponse($response);
    }
}

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

{"status":"OK","result":{"you_response":"your response data"}}

The URL for above example will be http://yourdomain.com/foo/bar. You can customize it by setting the your module.config.php as following.

'router' => [
        'routes' => [
            'home' => [
                'type' => Literal::class,
                'options' => [
                    'route'    => '/',
                    'defaults' => [
                        'controller' => Controller\FooController::class,
                        'action' => 'bar',
                        'access_public' => true // set true if this api NOT Required JWT Authorization eg. login.
                    ],
                ],
            ],
        ],
    ],

Simple :)

Configurations

This module provides several configurations related to JWT authentication. The default configurations are in previously you copy and past file this restapi.global.php have configurations`.

<?php

return [
    'ApiRequest' => [
        'jwtAuth' => [
            'cypherKey' => 'R1a#2%dY2fX@3g8r5&s4Kf6*sd(5dHs!5gD4s',
            'tokenAlgorithm' => 'HS256',
            'expireTime' => 300
        ],
    ]
];

Request authentication using JWT

By default any API method will require an auth token in a request. You can pass the auth token in either header, in GET parameter or in POST field.

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

Authorization: Bearer [token]

Example:
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjoidmFsdWUifQ.xQgVrW5o3iNzA4iY3NDKwDp-pYoIhr-vyFgmi9RuMFo

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

Generate jwt token

This module provides methods to generate jwt token and sign with same key and algorithm. Use $this->generate() method wherever required. Most probably, you will need this in to user login and register API. See below example,

public function login()
{
    /**
     * process your data and validate it against database table
     */

    // generate token if valid user
    $payload = ['email' => $user->email, 'name' => $user->name];

    $this->apiResponse['token'] = $this->generateJwtToken($payload);

    $this->apiResponse['message'] = 'Logged in successfully.';
    return $this->createResponse();
}

Response format

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

{
  "status": "OK",
  "result": {
    //your result data
  }
}

Examples

Below one example to understand how this module works.

Retrieve articles

Let's create an API which returns a list of articles with basic details like id and title. Our controller will look like,

<?php

namespace Application\Controller;

use RestApi\Controller\ApiController;

/**
 * Articles Controller
 *
 * 
 */
class ArticlesController extends ApiController
{

    /**
     * index method
     *
     */
    public function indexAction()
    {
        // $this->token gives you to token which generated.
        // $this->tokenPayload gives you to payload details which you sets at the time of login or generate token.
        $payload = $this->tokenPayload;
        
        $articles = $this->entityManager->getRepository(Article::class)
                ->findBy([], ['id'=>'ASC']);

        $this->apiResponse['articles'] = $articles;
        return $this->createResponse();
    }
}

The response of above API call will look like,

{
  "status": "OK",
  "result": {
    "articles": [
      {
        "id": 1,
        "title": "Lorem ipsum"
      },
      {
        "id": 2,
        "title": "Donec hendrerit"
      }
    ]
  }
}

Reporting Issues

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