WellRESTed
, (*1)
WellRESTed is a micro-framework for creating RESTful APIs in PHP. It provides a lightweight yet powerful routing system and classes to make working with HTTP requests and responses clean and easy., (*2)
Requirements
Install
Add an entry for "pjdietz/wellrested" to your composer.json file's require
property. If you are not already using Composer, create a file in your project called "composer.json" with the following content:, (*3)
{
"require": {
"pjdietz/wellrested": "~2.3"
}
}
Use Composer to download and install WellRESTed. Run these commands from the directory containing the composer.json file., (*4)
$ curl -s https://getcomposer.org/installer | php
$ php composer.phar install
You can now use WellRESTed by including the vendor/autoload.php
file generated by Composer., (*5)
Overview
WellRESTed's primary goal is to facilitate mapping of URIs to classes that will provide or accept representations. To do this, create a Router
instance and load it up with some routes., (*6)
use pjdietz\WellRESTed\Response;
use pjdietz\WellRESTed\Router;
require_once "vendor/autoload.php";
// Create a new router.
$router = new Router();
// Populate the router with routes.
$router->add(
["/", "\\MyApi\\RootHandler"],
["/cats/", "\\MyApi\\CatHandler"],
["/dogs/*", "\\MyApi\\DogHandler"],
["/guinea-pigs/{id}", "\\MyApi\\GuineaPigHandler"],
["~/hamsters/([0-9]+)~", "\\MyApi\\HamsterHandler"]
);
// Output a response based on the request sent to the server.
$router->respond();
Documentation
See the documentation to get started., (*7)
Copyright and License
Copyright © 2015 by PJ Dietz
Licensed under the MIT license, (*8)