Podpora REST služeb v Nette 2.1

Potreboval som niečo podobné už v Netee 0.9.x, napísal som si na to vlastnú RestRoute:

<?php

class RestRoute extends Route
{
    const METHOD_POST = 4;
    const METHOD_GET = 8;
    const METHOD_PUT = 16;
    const METHOD_DELETE = 32;
    const RESTFUL = 64;

    public function match(IHttpRequest $httpRequest)
    {
        $httpMethod = $httpRequest->getMethod();

        if (($this->flags & self::RESTFUL) == self::RESTFUL) {
            $presenterRequest = parent::match($httpRequest);
            if ($presenterRequest != NULL) {
                switch ($httpMethod) {
                    case 'GET':
                        $action = 'default';
                        break;
                    case 'POST':
                        $action = 'create';
                        break;
                    case 'PUT':
                        $action = 'update';
                        break;
                    case 'DELETE':
                        $action = 'delete';
                        break;
                    default:
                        $action = 'default';
                }

                $params = $presenterRequest->getParams();
                $params['action'] = $action;
                $presenterRequest->setParams($params);
                return $presenterRequest;
            } else {
                return NULL;
            }
        }

        if (($this->flags & self::METHOD_POST) == self::METHOD_POST
            && $httpMethod != 'POST') {
                return NULL;
        }

        if (($this->flags & self::METHOD_GET) == self::METHOD_GET
            && $httpMethod != 'GET') {
                return NULL;
        }

        if (($this->flags & self::METHOD_PUT) == self::METHOD_PUT
            && $httpMethod != 'PUT') {
                return NULL;
        }

        if (($this->flags & self::METHOD_DELETE) == self::METHOD_DELETE
            && $httpMethod != 'DELETE') {
                return NULL;
        }

        return parent::match($httpRequest);
    }
}
?>

Použitie:

<?php

$router[] = new RestRoute('/1.0/resource/<id [0-9]+>', array(
    'presenter' => 'Resource',
    'action' => 'default',
), RestRoute::METHOD_GET);

$router[] = new RestRoute('/1.0/resource/<id [0-9]+>', array(
    'presenter' => 'Resource',
    'action' => 'delete'
), RestRoute::METHOD_DELETE);

?>

Mně se to nelíbí. Tohle by měl řešit presenter, né router. Respektive, nevidím důvod, proč by každá akce nemohla mít annotaci, jaké HTTP metody zpracovává (cca tak jako v RoR). To chcete mít milion rout?

Editoval HosipLan (9. 5. 2012 10:39)

Máš pravdu, že u rout je potřeba rozlišovat, jestli je možné danou akci vůbec zpracovat, to tedy musí být na úrovni routování. Jak se ale zbavit potřeby, mít routu pro každou hloupost?

REST je forma routování používající pro akci HTTP metodu. Cílem REST routeru tedy není rozlišovat routy podle metody, ale podle metod stanovit action. V REST routě tak stačí uvést jen zdroj, se kterým pracuju, a to je všechno.

$routes[] = new RestRoute(‚posts‘);

A umožní mi to následující:

GET    /posts        | index             | Render a list of all post
GET    /posts/new    | new               | Render a form for creating a single new post
POST   /posts        | create            | Create a single new post from the received data
GET    /posts/1      | show              | Render a single existing post
GET    /posts/1/edit | edit              | Render a form for editing a single existing post
PUT    /posts/1      | update            | Update a single existing post based on the received data
DELETE /posts/1      | destroy           | Destroy a single existing post

Používání HTTP metod, jako je tomu třeba v Rails, je dle mého omyl, protože takové odkazy nelze vytvářet. Leda AJAXem a ne v každém browseru. Proto musí fungovat tohle:

GET    /posts           | index             | Render a list of all post
GET    /posts/new       | new               | Render a form for creating a single new post
GET    /posts/create    | create            | Create a single new post from the received data
GET    /posts/1         | show              | Render a single existing post
GET    /posts/1/edit    | edit              | Render a form for editing a single existing post
GET    /posts/1/update  | update            | Update a single existing post based on the received data
GET    /posts/1/destroy | destroy           | Destroy a single existing post

Což můžeme zapsat cca jako

$router[] = new Route('<resource>[/<id>][/<action>]');

RestRoute by mělo mít oproti Route navíc logiku, která podle přítomnosti/nepřítomnosti id zvolí mezi show a index apod. Samozřejmě může taky respektovat HTTP metodu.

paranoiq Hm, Davidem odkazovaný článek zase tvrdí opak. PUT jako UPDATE a POST jako CREATE implementuje například i Backbone.js, a předpokládám, že tomu tak bude s naprostou většinou knihoven využívajícíh RESTový CRUD.

Rozhodně PUT === UPDATE, nebo alespoň pro ty, co chtějí být kompatibilní s REST specifikací a 99,99% světa. :)

@David Grudl: Přiznám se, že jsem z toho Tvého popisu trochu zmaten a přemýšlím, jestli jsem o pár příspěvků výše nemluvil o koze a Ty teď o voze. :)

Všechna čistokrevná REST API, se kterými jsem se kdy setkal, rozlišovala to, co se má dít, právě podle kombinace metody a URL. Zkrátka když volám URL /posts metodou GET, čtu data, když volám URL /posts metodou POST, vytvářím nový záznam. IMHO tam nepatří žádné /posts/create a podobné „berličky“ (to ještě za chvíli rozvedu).

Že na to nelze vytvořit odkaz přece vůbec nevadí, protože kdo by odkazoval na webu přímo na nějaké REST API? K čemu by to mělo být dobré? K REST API se většinou vytváří pouze API dokumentace a v té se zpravidla jako API metoda považuje kombinace metody a URL adresy.

A také mi moc nedává smysl Tebou zmíněná URL /posts/new, která by měla vykreslovat nějaký formulář? REST API typicky vrací nějakou JSON nebo XML strukturu. Nějaké HTML přece patří až do aplikaci, která je nad API postavená.

Ještě k těm berličkám… Již jsem zažil taková REST API, ve kterých se vše volalo GET metodou a URL měly právě tvar /posts/create, /posts/delete a tak podobně, ale tohle už není REST API v pravém slova smyslu.

No, přiznám se, že pokud by se do Nette mělo dostat nativně něco, co není REST v pravém slova smyslu… tak to bych tam asi radši osobně nedával nic. :)

Editoval Tharos (16. 5. 2012 22:45)

Ostatně může fungovat pravý rest + berličky najednou. DELETE /posts/1 a třeba GET /posts/1/delete nebo GET /posts/1?method=delete by routa hodila na tu samou akci.

Vykreslování formuláře mi přijde taky navíc.

Díky Tharos :) Eh… PUT, UPDATE, POST… spletl jsem si to, teprve teď mi došlo, že ty, Hosiplan i já říkáme to samé :)

Jestli jsem pochopil správně tu Erikovu routu, tak přeci jediná stačí obsloužit všechny REST presentery, například takto:

<?php
$router[] = new RestRoute('rest/<presenter>/<id [0-9]+>', array(
    'presenter' => 'Resource',
    'action' => 'default',
), RestRoute::RESTFUL);
?>

Tedy funguje úplně stejně normální routování, akorát action se přířadí podle metody.

Editoval jasir (17. 5. 2012 1:26)

Pro pestřejší paletu, Backbone.js zase využívá hlavičky X-HTTP-Method-Override, kde uvádí název metody (PUT nebo DELETE), ve skutečnosti realizované skrze POST.

Shodou okolností nebo protože nic neexistovalo sem na něco podobného dělal.
https://gist.github.com/2781069 není to dokončené, ale už tak obsluhuji, některé požadavky.

Tharos napsal(a):

Již nějaký měsíc používám lehce modifikovanou verzi té od Erika (už ji zde na fóru totiž jednou publikoval) a funguje výborně. Takže já bych klidně hlasoval za její přímé začlenění. :)

V abstraktním předkovi REST presenterů mám také takovou zkratku pro pohodlnější dolování proměnných předaných v těle HTTP požadavku…

Ahoj, mě to v PHP 5.3.5 nefunguje. Musím například PUT request číst takto:

parse_str(file_get_contents("php://input"),$put_vars);

možná jdou pro čtení používat i tyto funkce http://php.net/…est-body.php

Editoval patriksima (25. 7. 2012 9:13)

Zdravím, jak toto dopadlo prosím?

Dále se chci zeptat, nebylo by také dobré, když už teda framework si je vědom toho, že zpracovává požadavek na REST službu, aby předal i data do parametru metody? Použiju Davidům příklad:

GET    /posts			| actionDefault($id = null, $data = null)	| Render a list of all post
GET    /posts?offset=10	| actionDefault($id = null, $data = null)	| Render a form for creating a single new post
POST   /posts			| actionPostDefault($data)					| Create a single new post from the received data
GET    /posts/1			| actionDefault($id = null, $data = null)	| Render a single existing post
PUT    /posts/1			| actionPut($id, $data = null)				| Update a single existing post based on the received

Samozřejmě proměnná $data tedy bude vždy obsahovat pole/strukturu s daty dané metody.

Editoval Zdeněk Topič (15. 11. 2012 23:59)