„HTTP verbs“, RESTful architektura

Zajímavé. V nette jsem dělal i jenom API web, ale vzhledem k minimální velikosti a rychlosti celého Nette je celkem nemístné vyřazovat AppForm. Je pravda, že některé frameworky s http akcemi pracují – třeba rails takhle rovnou tvoří crud. Nicméně, protože Nette modelovou část nemá, nestará se o tyhle svázané záležitosti.

Každopádně, podle mě by určitě stačilo udělat si vlastní abstraktní ApiPresenter který se o http akce náležitě postará, jakákoliv úprava Nette je zbytečná. Nebo je v něčem problém?

Honza Marek napsal(a):

Možná by ti mohlo pomoct přepsání metody formatActionMethod v presenteru.

Ano, to by mi pomohlo, díky :). A teď další věc: Chtěl bych důsledně oddělit identifikátory (ID produktu, článku) od dat (jméno produktu, nadpis) a ke všem datům se chovat stejně. HttpRequest->getPost() bych asi nahradil něčím jako getParam(‚jmeno‘), protože to, jakou metodou jsem data dostal, je vůbec první věc, o kterou se starám, a pak jsou si parametry vlastně rovny.

Mikulas Dite: Asi by to šlo. Nechtěl bys zkusit něco takového zhruba načrtnout? Když už zmiňuješ RoR, tak tam bych to rozhodně netlačil, nejsem nijak ortodoxní zastánce REST. Nette se mi až na tohle líbí, jak je. Bez konkrétní databázové vrsty a kompletně rozložitelné.

Editoval PJK (22. 6. 2010 20:58)

Metóda by sa mala podľa mňa definovať v route, a preto som si napísal toto:

<?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);
    }
}

Príklad použitia:

$router = $application->getRouter();

$router[] = new RestRoute('/api/1.0/mailbox/', array(
    'presenter' => 'Mailbox',
    'action' => 'default',
), RestRoute::METHOD_GET);

$router[] = new RestRoute('/api/1.0/mailbox/', array(
    'presenter' => 'Mailbox',
    'action' => 'create',
), RestRoute::METHOD_POST);

Áno, alebo môžeš použiť RestRoute::RESTFUL flag:

/* priradí akcie k jednotlivým http metódam
GET => default
POST => create
PUT => update
DELETE => delete
*/

$router[] = new RestRoute('/api/1.0/mailbox/', array(
    'presenter' => 'Mailbox'
), RestRoute::RESTFUL);

PJK napsal(a):

Erik Ferčák: Pokud tomu dobře rozumím, každá metoda jedné resource by měla vlastní routu, ano?

vrtak-cz napsal(a):

A nebylo by jednodušší kdyby jsi mohl prostě a jednoduše definovat překladový slovník pro jednotlivé REST požadavky?

Pak by bylo prostě pole

//Method => Action
array(
	'GET' => "default",
	'POST' => "create",
	'PUT' => "update",
	'DELETE' => "delete"
);

Asi takto? (netestované)

<?php

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


    protected static $restDictionary = array(
        'GET' => 'default',
        'POST' => 'create',
        'PUT' => 'update',
        'DELETE' => 'delete'
    );


    public static function setRestDictionary(array $dictionary)
    {
        self::$restDictionary = array_merge(self::$restDictionary, $dictionary);
    }


    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':
                    case 'POST':
                    case 'PUT':
                    case 'DELETE':
                        $action = self::$restDictionary[$httpMethod];
                        break;
                    default:
                        $action = self::$restDictionary['GET'];
                }

                $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);
    }
}

// predefinovať akcie potom následovne:
RestRoute::setRestDictionary(array(
    'GET' => 'list',
    'POST' => 'add'
));

/*
 výsledný slovník potom vyzerá takto:

  'GET' => 'list',
  'POST' => 'add',
  'PUT' => 'update',
  'DELETE' => 'delete'
*/

Řeším zrovna implementaci jedné webové služby a zde uváděná REST routa mi vyhovuje, akorát bych se zeptal stejně jako PJK, je nějaký lepší způsob, jak přistoupit k datům z PUT requestu?

V jakým smyslu přiohnout?
Podědit a přidělat metody jako „getPut“ a „getDelete“, ve kterých požadovaný data dostat z php://input a naplnit potřebný pole?

Jsem jednoznačně pro, aby to bylo přímo v nette! V asp.net mvc se to řeší anotacema, s čímž by ale tady byl problém, protože by kolidovaly jména metod…