free-elephants/rest-daemon

PHP http socket REST server

Monday, February 12, 2018
by samizdam
Repository
2 Watchers
3 Stars
123 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
3 Open issues
25 Versions
3 % Grown

The README.md

Rest-Daemon

, _(*1)

Nota Bene: This project uses semver and changelog. But it's not a stable major version. Any minor update (f.e. 0.5.* -> 0.6.*) can break backward compatibility!, _(*2)

Simple PHP7 framework for fast building REST services based on middleware, PSR-7 and react., _(*3)

Runned instance can be found by link, also see example repo., _(*4)

Features:

Middleware oriented request/response handling
Priority PSR's support: PSR-2, -3, -4, -7, -11, -15 and other.
Built-in Middleware to support usual REST features, like HTTP based semantics, content types, request parsing, headers.
Choose one of two available http-daemon drivers: Ratchet ReactPHP or Aerys.
Swagger Integration

Installation

$ composer require free-elephants/rest-daemon

Usage

See example in example/rest-server.php and documentation., _(*5)

Create and Run Server:

# your rest-server.php script
$server = new RestServer('127.0.0.1', 8080, '0.0.0.0', ['*']); // <- it's default arguments values
$server->run();

# can be runned as
$ php ./rest-server.php

Add Your RESTful API Endpoints

Any endpoint method handler can be Middleware-like callable implementation: function or class with __invoke() method., _(*6)

<?php
class GetAttributeHandler extends AbstractEndpointMethodHandler
{

    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
    {
        $name = $request->getAttribute('name', 'World');
        $response->getBody()->write('{
            "hello": "' . $name . '!"
        }');
        return $next($request, $response);
    }
}

$greetingAttributeEndpoint = new BaseEndpoint('/greeting/{name}', 'Greeting by name in path');
$greetingAttributeEndpoint->setMethodHandler('GET', new GetAttributeHandler());

$server->addEndpoint($greetingAttributeEndpoint);

See how to build server for step by step in one script, _(*7)

RestServerBuilder

You can use php-di (or another PSR-11 container implementation) and routing file configuration with RestServerBuilder for more configuring and coding less., _(*8)

See example with file based routing and dependencies configuration: rest-server.php, _(*9)

Routing

You can link with every method in route a handler, and optionally organize routes by modules. By default server contain 1 default module for all endpoints. See example: routes.php, _(*10)

Configure Common Application Middleware

By default server instance provide collection with some useful middleware. You can extend or override it:, _(*11)

<?php
$requestCounter = function (
    ServerRequestInterface $request,
    ResponseInterface $response,
    callable $next
) {
    static $requestNumber = 0;
    printf('[%s] request number #%d handled' . PHP_EOL, date(DATE_ISO8601), ++$requestNumber);

    return $next($request, $response);
};
$extendedDefaultMiddlewareCollection = new DefaultEndpointMiddlewareCollection([], [$requestCounter]);
$server->setMiddlewareCollection($extendedDefaultMiddlewareCollection);

Every endpoint's method handler will be wrapped to this collection and called between defined as after and before middleware. Also you can configure default middleware collection with access to every built-in middleware by key: this collection implements ArrayAccess interface., _(*12)

<?php
$server->getMiddlewareCollection()->getBefore()->offsetUnset(\FreeElephants\RestDaemon\Middleware\MiddlewareRole::NO_CONTENT_STATUS_SETTER);

Customize Endpoint Middleware

... Will be implemented..., _(*13)

Debugging and Logging

... Will be implemented..., _(*14)

The Versions

12/02 2018

dev-master

9999999-dev

PHP http socket REST server

library rest-daemon

PHP http socket REST server

free-elephants/rest-daemon

The README.md

Rest-Daemon

Features:

Installation

Usage

Create and Run Server:

Add Your RESTful API Endpoints

RestServerBuilder

Routing

Configure Common Application Middleware

Customize Endpoint Middleware

Debugging and Logging

The Versions

dev-master

The Requires

The Development Requires

by samizdam

dev-logger

The Requires

The Development Requires

by samizdam

dev-bin-distr

The Requires

The Development Requires

by samizdam

0.12.0

The Requires

The Development Requires

by samizdam

dev-react-php-driver

The Requires

The Development Requires

by samizdam

dev-swagger-integration

The Requires

The Development Requires

by samizdam

0.11.0

The Requires

The Development Requires

by samizdam

0.10.0

The Requires

The Development Requires

by samizdam

0.9.0

The Requires

by samizdam

0.8.0

The Requires

by samizdam

0.7.1

The Requires

by samizdam

0.7.0

The Requires

by samizdam

0.6.1

The Requires

The Development Requires

by samizdam

0.6.0

The Requires

The Development Requires

by samizdam

dev-Vehsamrak-patch-1

The Requires

The Development Requires

by samizdam

0.5.0

The Requires

The Development Requires

by samizdam

dev-travis-integration

The Requires

The Development Requires

by samizdam