jsonful/server

JSON server

Maintainers

Details

github.com/JSONful/server

Source

Issues

Installs: 334

Dependents: 0

Suggesters: 0

Security: 0

Stars: 13

Watchers: 6

Forks: 3

Open Issues: 0

v0.1.3 2016-11-11 20:32 UTC

Requires

MIT aab7ec73f8706a5b0b4fdaadb5b9dd69ea142bb2

  • Cesar Rodas <cesar.woop@rodas.me>

This package is not auto-updated.

Last update: 2024-12-21 19:39:26 UTC

README

JSONful is a framework which helps creating API servers.

Features

  1. Ease of use
  • It exposes regular PHP functions to the API, making it easy to integrate with any other framework and existing code.
  • It is easy to make cross domain requests ($server['public'] = true;)
  • The javascript client works out of the box and it's optimized for performance
    • The client concatenates many requests and sending it in a single HTTP request.
    • It has no dependency, and it can be used with WebPack or directly.

Installation

composer require jsonful/server

Usage

api.php

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

$server new JSONful\Server(__DIR__ . '/apps');
$server->run();

apps/prime.php

/** @API("prime") */
function is_prime($number)
{
    if ($number <= 0) {
        return false;
    }
    $middle = ceil($number/2);
    for ($i = 2; $i <= $middle; ++$i) {
        if ($number % $i === 0) {
            return false;
        }
    }
    return true;
}

/** @API("ping") */
function ping() {
    return ['pong' => time()];
}

client.js

var client = new JSONful("https://api.myapp.net/");

client.exec("ping", function(err, response) {
  console.log(response); // {"pong": xxxx}
}
client.exec("prime", 99).then(function(response) {
  console.error(response); // false
});