library slim-rest-api

patricksavalle/slim-rest-api

Production-grade REST-API App-class for PHP SLIM

Ready-to-go REST API for PHP SLIM

Uses PHP 7.x syntax, _(*1)

Turns the default SLIM App-class into a production-grade JSON REST-API base-class: - adds (GET, POST and header) parameter validation for added security and self-documentation - adds robust exception and assert handling / sets-up the PHP interpreter for exceptions so 'normal' errors will throw exceptions that you can catch. - translates unhandled exceptions into 'normal' JSON-responses with the correct HTTP-STATUS - translates unknown routes/URL's and methods into 'normal' 403 and 404 JSON-responses - CLI support to accept and protect for instance cronjob calls from the server - Middleware for database optimisation and memcache support - Query caching (using APCu), _(*2)

Very simple to use, just use the SlimRestApi-class instead of the standard Slim App-class., _(*3)

Edit the slim-rest-api.ini for correct (database) configuration., _(*4)

Example index.php:, _(*5)

<?php

declare(strict_types = 1);

namespace YourApi;

define("BASE_PATH", dirname(__FILE__));

require BASE_PATH . '/vendor/autoload.php';

use SlimRequestParams\BodyParameters;
use SlimRequestParams\QueryParameters;
use SlimRestApi\Middleware\CliRequest;
use SlimRestApi\Middleware\Cacheable;
use SlimRestApi\Middleware\ReadOnly;
use SlimRestApi\SlimRestApi;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

class YourApi extends SlimRestApi
{
    public function __construct()
    {
        // call parent ctor before anything else!
        parent::__construct();

        // Add a route
        $this->get("/echo", function (
            ServerRequestInterface $request,
            ResponseInterface $response,
            \stdClass $args)
        : ResponseInterface
        {
            return $response->withJson(QueryParameters::get());
        })
            ->add(new QueryParameters([
                '{string:.{30}},the lazy fox',
                '{mandatory_int:\d{1,10}}',
                '{char:[[:alnum:]]{1}},a',
                '{int:\int},1',
                '{bool:\bool},true',]))
            ->add(new ReadOnly);
    }
}

// instantiate and run
(new YourApi)->run();

Start the PHP server:, _(*6)

php -S localhost:8000

Open this URL's in your browser (see what happens):, _(*7)

http://localhost:8000/echo 
http://localhost:8000/echo?mandatory_int=1
http://localhost:8000/echo?mandatory_int=1&bool=false

Setup

• Install with Composer
• Update your composer.json to require patricksavalle/slim-rest-api.

• Run composer install to add slim-rest-api your vendor folder., _(*8)

  {
    "require": 
    {
      "patricksavalle/slim-rest-api": "^1.0"
    }
  }

• Include in your source., _(*9)

  <?php
  require './vendor/autoload.php';

• Copy the slim-rest-api.ini file to the project-root and edit (put in your settings), _(*10)

Available Middleware

This packages comes with a minimum of (optional) helpers and middleware., _(*11)

Validate parameters of a route

See: https://github.com/patricksavalle/slim-request-params, _(*12)

use SlimRequestParams\BodyParameters;
use SlimRequestParams\QueryParameters;

Set route to read-only

Sets route to read-only, optimising the database engine, adding a layer of robustness by preventing unwanted updates to the database., _(*13)

use SlimRestApi\Middleware\ReadOnly;
$YourApp->get(...)->add( new ReadOnly );

If you use other middleware (e.g. authentication) that needs write-access, chain them AFTER this method, like so, _(*14)

use SlimRestApi\Middleware\ReadOnly;
$YourApp->get(...)
    ->add( new ReadOnly )
    ->add( new Authentication )
    -> ...

Set route to CLI / command-line only

Very usefull for functions that should not be exposed over HTTP (such as cronjob callbacks or configuration methods). For examples see: https://github.com/pavlakis/slim-cli, _(*15)

use SlimRestApi\Middleware\CliRequest;
$YourApp->get(...)->add( new CliRequest );

Available helpers

Database / PDO access

Makes database access as simple as possible. Automatically handles prepared-statement usage. Adds supersimple transaction support., _(*16)

use SlimRestApi/Db;
$obj = Db::transaction(function(){
    $obj = Db::execute("SELECT * FROM yourtable LIMIT 1")->fetch();
    $obj->some_field = 'changed';
    Db::update($obj);
    return $obj;
});

All PDO-statements are accessible through the Db-singleton (magic method). To prevent warnings use:, _(*17)

/** @noinspection PhpUndefinedMethodInspection */

Easy query caching (using APCu)., _(*18)

INI-file / configuration

Makes INI's as simple as possible. Looks for a 'slim-rest-api.ini' file in the webroot, see project for axeample., _(*19)

Uue SlimeRestApi/Ini;
$value = Ini::get('key');

Memcaching of methods and functions

Provides a memcached version of call_user_func_array(). Use only for true functions (i.e. code without side-effects so the result depends only on the function-argument)., _(*20)

use SlimRestApi/Memcache;
$value = Memcache::call_user_func_array(...);

These functions actually uses APCu as caching engine., _(*21)

Contributing

Fork it., _(*22)

• Create your feature branch (git checkout -b my-new-feature).
• Commit your changes (git commit -am 'Added some feature').
• Push to the branch (git push origin my-new-feature).
• Create a new Pull Request.