nafisc/synful

This package is abandoned and no longer maintained. No replacement package was suggested.

Create simplified custom API's in minutes

v2.1.6 2019-03-12 18:35 UTC

Requires

• php: >=7.1
• illuminate/database: ^5.6
• illuminate/events: ^5.6
• nafisc/parameterparser: ^0.2.1
• samrap/gestalt: >=0.1.2
• touhonoob/rate-limit: ^1.2

Suggests

• ext-apcu: ^4.0

MIT

• Nathan Fiscaletti

• rest
• api
• synful

README

Credits

This repository has been archived.

What is it?

Synful is a simple PHP framework that gives you the tools to create a custom web API in minutes.

How can I get it?

Head over to The Wiki Pages for information on how to get Synful and what the next steps are to get your custom API up and running!

Benchmark

On a Vagrant box with 4096MB RAM, 4x CPU, running a LAMP stack using the GetIpExample.php Request Handler.

$ sudo ab -t 60 -c 5 http://127.0.0.1/example/getip
...
Requests per second:    6545.17 [#/sec] (mean)

Preview (RequestHandler)

namespace App\RequestHandlers;

use \Synful\Framework\RequestHandler;
use \Synful\Framework\Request;

/**
 * Example RequestHandler.
 */
class GetIPExample extends RequestHandler
{
    /**
     * Override the handler endpoint
     * Example: http://myapi.net/user/search
     * uses the endpoint `user/search`.
     *
     * @var string
     */
    public $endpoint = 'example/getip';

    /**
     * Handles a GET request type.
     *
     * @param  \Synful\Framework\Request $request
     * @return \Synful\Framework\Response|array
     */
    public function get(Request $request)
    {
        return [
            'ip' => $request->ip,
        ];
    }
}