78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
WellRESTed
|
|
==========
|
|
|
|
[](https://travis-ci.org/wellrestedphp/wellrested)
|
|
[](http://wellrested.readthedocs.org/en/latest/)
|
|
[](https://insight.sensiolabs.com/projects/b0a2efcb-49f8-4a90-a5bd-0c14e409f59e)
|
|
|
|
WellRESTed is a library for creating RESTful Web services and websites in PHP.
|
|
|
|
Requirements
|
|
------------
|
|
|
|
- PHP 7.0
|
|
|
|
Install
|
|
-------
|
|
|
|
Add an entry for "wellrested/wellrested" to your composer.json file's `require` property.
|
|
|
|
```json
|
|
{
|
|
"require": {
|
|
"wellrested/wellrested": "~3.1"
|
|
}
|
|
}
|
|
```
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
See [the documentation](https://wellrested.readthedocs.org/en/latest/) to get started.
|
|
|
|
Example
|
|
-------
|
|
|
|
```php
|
|
<?php
|
|
|
|
use Psr\Http\Message\ResponseInterface;
|
|
use Psr\Http\Message\ServerRequestInterface;
|
|
use Psr\Http\Server\RequestHandlerInterface;
|
|
use WellRESTed\Message\Response;
|
|
use WellRESTed\Message\Stream;
|
|
use WellRESTed\Server;
|
|
|
|
// Create a handler using the PSR-15 RequestHandlerInterface
|
|
class HomePageHandler implements RequestHandlerInterface
|
|
{
|
|
public function handle(ServerRequestInterface $request): ResponseInterface
|
|
{
|
|
// Create and return new Response object to return with status code,
|
|
// headers, and body.
|
|
$response = (new Response(200))
|
|
->withHeader('Content-type', 'text/html')
|
|
->withBody(new Stream('<h1>Hello, world!</h1>'));
|
|
return $response;
|
|
}
|
|
}
|
|
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Create a new server.
|
|
$server = new Server();
|
|
|
|
// Add a router to the server to map methods and endpoints to handlers.
|
|
$router = $server->createRouter();
|
|
$router->register('GET', '/', new HomePageHandler());
|
|
$server->add($router);
|
|
|
|
// Read the request from the client, dispatch a handler, and output.
|
|
$server->respond();
|
|
```
|
|
|
|
Copyright and License
|
|
---------------------
|
|
Copyright © 2018 by PJ Dietz
|
|
Licensed under the [MIT license](http://opensource.org/licenses/MIT)
|