index.html

---
layout: default
---

<div class="home">

    <h1>WellRESTed</h1>
    <p>WellRESTed is a library for creating RESTful APIs and websites in PHP
        that provides abstraction for HTTP messages, a powerful middleware
        system, and a flexible router.</p>

{% highlight php %}
<?php

namespace App;

use DI;
use Psr\Container\ContainerInterface;
use WellRESTed\Server;

require_once 'vendor/autoload.php';

$builder = new DI\ContainerBuilder();
$builder->addDefinitions([
    Server::class => function (ContainerInterface $c): Server {
        $server = new Server();
        $server->add(ErrorMiddleware::class);

        $router = $server->createRouter();
        $server->addRoute($router);

        $router
            ->register('GET', '/', HomeHandler::class)
            ->register('GET', '/cats/', CatsListHandler::class)
            ->register('POST', '/cats/', [
                AuthMiddleware::class,
                JsonMiddleware::class,
                CatCreateHandler::class
            ])
            ->register('GET', '/cats/{id}', CatHandler::class)
            ->register('PUT', '/cats/{id}', [
                AuthMiddleware::class,
                JsonMiddleware::class,
                CatUpdateHandler::class
            ])
            ->register('DELETE', '/cats/{id}', [
                AuthMiddleware::class,
                CatDeleteaHandler::class
            ]);

        return $server;
    }
]);

$container = $builder->build();
$server = $container->get(Server::class);
$server->respond();
{% endhighlight %}

    <h2>Features</h2>

    <div class="row">
        <div class="col-sm-6">
            <h3>PSR-7</h3>
            <p>Requests and responses are built to the interfaces standardized by
                <a class="no-break" href="https://www.php-fig.org/psr/psr-7/">PSR-7</a> making it easy to
                share code and use components from other libraries and frameworks.</p>
        </div>
        <div class="col-sm-6">
            <h3>PSR-15</h3>
            <p>Build your application using handlers and middleware implementing the interfaces defined by <a class="no-break" href="https://www.php-fig.org/psr/psr-15/">PSR-15</a>.
        </div>
    </div>
    <div class="row">
        <div class="col-sm-6">
            <h3>Router</h3>
            <p>Use a <a href="https://wellrested.readthedocs.io/en/latest/router.html">
                router</a> to map HTTP methods and paths to hanlders, middleware, or sub-routers.
        </div>
        <div class="col-sm-6">
            <h3>URI Templates</h3>
            <p>Use <a href="https://wellrested.readthedocs.io/en/latest/uri-templates.html">URI templates</a>
                like <code>/foo/{bar}/{baz}</code>, <code>/list/{items*}</code>, or
                <code>{/path*}</code> that match patterns of paths and provide captured
                variables.</p>
        </div>
    </div>
    <div class="row">
        <div class="col-sm-6">
            <h3>Lazy Dispatching</h3>
            <p>WellRESTed's dispatcher can delay instantiating handlers until they're
                needed, so even large apps can stay light weight.</p>
        </div>
        <div class="col-sm-6">
            <h3>Dependency Injection</h3>
            <p>WellRESTed does not supply a DI container, but can work with any
                an any <a class="no-break" href="https://www.php-fig.org/psr/psr-11/">PSR-11</a>
                container.</p>
        </div>
    </div>

    <h2>Installation</h2>
    <p>The recommended method for installing WellRESTed is to use <a href="https://getcomposer.org/">Composer</a>. Add
        an entry for WellRESTed in your project’s composer.json file.</p>

{% highlight json %}
{
  "require": {
     "wellrested/wellrested": "^6"
  }
}
{% endhighlight %}

    <h2>Requirements</h2>
    <ul>
        <li>PHP 8.1</li>
    </ul>

    <h2>Documentation</h2>
    <p>The documentaiton for WellRESTed is available at
        <a href="https://wellrested.readthedocs.io">https://wellrested.readthedocs.io</a></p>

</div>