Exposer des services web SOAP et REST avec symfony 1.4 et Zend Framework

Exposer des services web
SOAP et REST

RMLL - 6 juillet 2010

Sensio Labs Workshop www.symfony-project.org trainings.sensiolabs.com

mardi 6 juillet 2010

Qui suis-je ?

❖ Hugo HAMON (@hhamon)

❖ Responsable des formations chez Sensio Labs

❖ Coauteur et contributeur d’ouvrages

❖ Secrétaire Général de l’AFUP

❖ Webmaster du site Apprendre-PHP.com
❖ http://www.hugohamon.com



Introduction aux Web services



Les services web

❖ Programmes destinés à échanger des données entre systèmes hétérogènes
❖ Basés sur des standards (SOAP) ou des styles d’architecture (REST)
❖ Fonctionnent en mode Client / Serveur (requête / réponse)
❖ Echange de données préformattées (XML, JSON, YAML, HTML...)
❖ Faible couplage grâce aux standards ouverts comme XML
❖ Faciles à mettre en oeuvre



Architecture REST



REST c’est quoi ?

❖ REpresentational State Transfert
❖ Concept inventé par Roy Fielding en 2000
❖ REST est un style d’architecture !
❖ REST s’appuie sur les concepts suivants :
❖ Le protocole HTTP (requête / réponse)
❖ La notion d’URI qui identiﬁe chaque ressource
❖ Les méthodes HTTP (GET, POST, PUT, DELETE, HEAD)
❖ Les codes de statut (200, 201, 403, 404, 500...)
❖ Les formats ouverts (XML, JSON, HTML...)
❖ REST est simple à mettre en oeuvre



La notion d’URI dans REST

❖ Chaque URI identiﬁe une ressource

http://api.domain.com/users/hugo

❖ Une URI ne contient pas de verbe !

❖ Une même URI peut être appelée avec différentes méthodes HTTP

GET http://api.domain.com/users Récupère les utilisateurs

POST http://api.domain.com/users Crée un nouvel utilisateur



Les méthodes HTTP

❖ GET, POST, PUT, DELETE et HEAD
❖ Identiﬁent les actions réalisables sur la ressource

GET http://api.domain.com/users Récupère les utilisateurs

POST http://api.domain.com/users Crée un nouvel utilisateur

PUT http://api.domain.com/users/hugo Modiﬁe hugo

DELETE http://api.domain.com/users/hugo Supprime hugo

❖ Opérations CRUD sur les ressources


Les codes HTTP de retour
❖ Indiquent l’état (succès ou échec) de l’opération effectuée

Méthodes En cas de succès En cas d’échec

201 Created
POST 400 Bad Request
Redirection vers l’URI de l’objet

400 Bad Request
PUT 200 OK 404 Not Found
409 Conﬂict

400 Bad Request
DELETE 200 OK 404 Not Found
410 Gone

GET 200 OK 400 Bad Request
404 Not Found



Symfony
un framework RESTfull



Introduction



Présentation de symfony

❖ Framework PHP 5 MVC Open Source « full stack »
❖ Rapid Application Development
❖ Publié en 2005 sous licence MIT
❖ Bâti pour répondre à des besoins complexes
❖ « best practices » (design patterns, mvc, tests unitaires...)
❖ Maintenu par Sensio Labs jusqu’à ﬁn 2012
❖ Documentation riche et Open Source (4 livres ofﬁciels)
❖ Communauté très active



Outillage de symfony

MVC Propel CLI (CRUD)

Tests Automatisés ACL

Plugins Cache

I18N & L10N Doctrine RESTful routing



Un routing RESTFull



Routage de symfony

❖ Symfony découple les URLs du code (implémentation technique)

/blog.php?section=symfony&article_id=18475

/blog/2008-01-30/symfony-happy-new-year

❖ Optimisation pour les moteurs de recherche
❖ URIs faciles à copier / coller, mémoriser ou bookmarker
❖ Masque l’implémentation technique (php, python, ruby ?)


Contraindre les routes aux méthodes HTTP

❖ sfRequestRoute permet de contraindre les URIs aux méthodes HTTP
❖ Une même URI peut être atteinte avec des méthodes HTTP différentes

user_edit:
class: sfRequestRoute
url: /api/users/:username
param: { module: user, action: update }
requirements: { sf_method: put }




$ php symfony app:routes api



❖ Symfony simule les requêtes PUT et DELETE depuis un navigateur
❖ Les formulaires embarquent un champ caché « sf_method »

<form action="/api_dev.php/api/user/hugo" method="post">
<input type="hidden" value="put" name="sf_method"/>
<input type="hidden" id="rmll_user_id" value="2" name="rmll_user[id]"/>
<input type="hidden" id="rmll_user__csrf_token"
value="94c132e7c771411590124aea52bb9d4f" name="rmll_user[_csrf_token]"/>

</form>


$params = array(
'method' => 'delete',
'confirm' => 'Etes-vous sûr de vouloir supprimer cet objet ?'
);

echo link_to('supprimer', 'user_delete', $object, $params);




$params = array(
'method' => 'delete',
'confirm' => 'Etes-vous sûr de vouloir supprimer cet objet ?'
);

echo link_to('supprimer', 'user_delete', $object, $params);

<li class="sf_admin_action_delete"><a href="/api_dev.php/api/user/hugo"
onclick="if (confirm('Are you sure?')) { var f = document.createElement
('form'); f.style.display = 'none'; this.parentNode.appendChild(f);
f.method = 'post'; f.action = this.href;var m = document.createElement
('input'); m.setAttribute('type', 'hidden'); m.setAttribute('name',
'sf_method'); m.setAttribute('value', 'delete'); f.appendChild(m);var m
= document.createElement('input'); m.setAttribute('type', 'hidden');
m.setAttribute('name', '_csrf_token'); m.setAttribute('value',
'f0271a52cca50e62df7deb1568f80489'); f.appendChild(m);f.submit
(); };return false;">Supprimer</a></li>



Les routes d’objets

user_edit

Route Objet Doctrine RmllUser

Base de données

user_edit:
class: sfDoctrineRoute
url: /api/users/:username
param: { module: user, action: update }
options: { model: RmllUser, column: username, type: object }
requirements: { sf_method: put }



Les routes d’objets
public function executeUpdate(sfWebRequest $request)
{
$user = $this->getRoute()->getObject();

$form = new RmllUserForm($user, array(), false);
$form->bind($request->getParameter('rmll_user'));

$status = 400;
if ($form->isValid())
{
$form->save();
$status = 200;
}

$this->getResponse()->setStatusCode($status);
return sfView::NONE;
}



Les collections de routes d’objets

❖ sfDoctrineRouteCollection ou sfPropelRouteCollection
❖ Actions CRUD sur un objet de modèle

user
user_new
user_create
user_edit
user_update
user_delete
user_show

Collection de routes Base de données Objet Doctrine RmllUser




user:
class: sfDoctrineRouteCollection
options:
model: RmllUser
module: user
prefix_path: /api/users
column: username
with_wildcard_routes: true
actions: [list, create, update, delete, show]



Support des formats de sortie



Support des formats de sortie

❖ Par défaut, symfony supporte le format HTML
❖ Le paramètre « sf_format » déﬁnit le format de sortie
❖ Symfony se charge d’envoyer les bons en-têtes en fonction de l’extension
user:
class: sfDoctrineRouteCollection
options:
model: RmllUser
module: user
prefix_path: /api/users
column: username
with_wildcard_routes: true
actions: [list, create, update, delete, show]
requirements: { sf_format: (?:html|xml|json) }



http://api.domain.com/users/hugo.xml




executeShow($request)




executeShow($request)

showSuccess.php showSuccess.xml.php showSuccess.json.php



<h1><?php echo $user ?></h1>
<table> showSuccess.php
<tbody>
<tr>
<td>Username</td>
<td><?php echo $user->getUsername() ?></td>
</tr>
<tr>
<td>Password</td>
<td><?php echo $user->getPassword() ?></td>
</tr>
<tr>
<td>First name</td>
<td><?php echo $user->getFirstName() ?></td>
</tr>
<tr>
<td>Last name</td>
<td><?php echo $user->getLastName() ?></td>
</tr>
<tr>
<td>Birthdate</td>
<td><?php echo $user->getBirthdate() ?></td>
</tr>
</tbody>
</table>



<?php echo '<?xml version="1.0" encoding="UTF-8" ?>'."n" ?>
<user>
<username><?php echo $user->getUsername() ?></username>
<firstName><?php echo $user->getFirstName() ?></firstName>
<lastName><?php echo $user->getLastName() ?></lastName>
<birthdate><?php echo $user->getBirthdate() ?></birthdate>
</user>
showSuccess.xml.php

showSuccess.json.php
{
"username": <?php echo json_encode($user->getUsername()) ?>,
"firstName": <?php echo json_encode($user->getFirstName(ESC_RAW)) ?>,
"lastName": <?php echo json_encode($user->getLastName(ESC_RAW)) ?>,
"birthdate": <?php echo json_encode($user->getBirthdate()) ."n" ?>
}



Sortie HTML

Sortie XML

Sortie JSON



Cache des résultats



❖ Symfony dispose nativement d’un cache HTML des pages
❖ Chaque sortie générée peut être mise en cache sur le serveur
❖ La durée de vie du cache de chaque page est conﬁgurable
❖ Le cache est par défaut stocké sur le système de ﬁchier (sfFileCache)

❖ Symfony offre la possibilité de choisir où stocker le cache :
❖ Fichiers (sfFileCache)
❖ SQLite (sfSQLiteCache)
❖ XCache (sfXCacheCache)
❖ MemCache (sfMemCacheCache)
❖ APC... (sfAPCCache)



❖ apps/api/modules/user/conﬁg/cache.yml

show:
enabled: true
with_layout: true
lifetime: 3600



Avant la mise en cache

336 ms

Après la mise en cache

50 ms



Tests Fonctionnels
de l’API



Simuler des requêtes GET
include(dirname(__FILE__).'/../../bootstrap/functional.php');

$browser = new RmllTestFunctional(new sfBrowser());
$browser->loadFixtures();

$browser->
get('/api/users/hhamon.xml')->

with('request')->begin()->
isFormat('xml')->
isParameter('module', 'user')->
isParameter('action', 'show')->
end()->

with('response')->begin()->
isStatusCode(200)->
isValid()->
end();





$browser->
get('/api/users/hhamon.xml')-> GET sur le ﬁchier XML
isFormat('xml')->
isParameter('module', 'user')->
end()->

isStatusCode(200)->
isValid()->
end();





$browser->
isFormat('xml')->
isParameter('module', 'user')-> Vériﬁcation de la requête
end()->

isStatusCode(200)->
isValid()->
end();





$browser->
isFormat('xml')->
isParameter('module', 'user')-> Vériﬁcation de la requête
end()->

isStatusCode(200)-> Vériﬁcation de la réponse
isValid()->
end();



$user = array(
'username' => 'pmartin',
'password' => 'something',
'first_name' => 'Paul',
'last_name' => 'Martin'
);

$user = getUser(array('birthdate' => ''));
$browser->
post('/api/users', array('rmll_user' => $user))->
with('response')->isStatusCode(400);

$browser->
post('/api/users', array('rmll_user' => getUser()))->
isStatusCode(201)->
isRedirected()->
end()->
followRedirect()



$user = array(
'first_name' => 'Paul', Test de la création avec des
'last_name' => 'Martin' paramètres manquants
);

$browser->

$browser->
isStatusCode(201)->
isRedirected()->
end()->
followRedirect()



$user = array(
'first_name' => 'Paul', Test de la création avec des
'last_name' => 'Martin' paramètres manquants
);

$browser->

$browser->
isStatusCode(201)->
isRedirected()->
end()->
followRedirect() Test de la création avec des
paramètres valides


Simuler des requêtes POST



Simuler des requêtes PUT
$user = getUser(array('first_name' => 'Toto'));
$browser->
call('/api/users/pmartin', 'put', array('rmll_user' => $user))->
with('response')->isStatusCode(200)
;



Simuler des requêtes DELETE

$browser->
call('/api/users/pmartin', 'delete')->



Architecture SOAP



Introduction à SOAP



Qu’est-ce que SOAP ?

❖ « Simple Object Access Protocol »
❖ SOAP est un protocole standard (http://www.w3.org/TR/soap/)

❖ Appel de procédure à distance reposant sur un standard XML
❖ SOAP permet d’invoquer des méthodes sur un objet distant
❖ La réponse est servie au client SOAP sous forme d’une réponse SOAP XML
❖ Transport des requêtes et réponses SOAP avec le protocole HTTP
❖ Les requêtes et réponses SOAP sont des chaînes XML
❖ Les données sont traitées sur le serveur puis converties en XML



Avantages et Inconvénients

❖ Avantages : ❖ Inconvénients :
✤ Standard éprouvé ✤ Lourd et lent
✤ Indépendant de la plateforme ✤ Verbosité du XML
✤ Indépendant du langage ✤ Difﬁcile à tester et à cacher
✤ Extensible



Fonctionnement de SOAP

http://domain.com/service?wsdl

http://domain.com/service

SOAP Client

SOAP Serveur

$service = new FooService();
$response = $s->calledMethod($param1, $param2);



Exposer des services SOAP
avec symfony et Zend



class ProjectConfiguration extends sfProjectConfiguration
{
static protected $zendLoaded = false;

public function setup()
{
$this->enablePlugins('sfDoctrinePlugin');
self::registerZend();
}

static public function registerZend()
{
if (self::$zendLoaded) {
return;
}

set_include_path(
sfConfig::get('sf_lib_dir').'/vendor'.PATH_SEPARATOR.get_include_path()
);
require_once sfConfig::get('sf_lib_dir').'/vendor/Zend/Loader/Autoloader.php';
Zend_Loader_Autoloader::getInstance();
self::$zendLoaded = true;
}
}



{
Framework Zend dans
lib/vendor/Zend
{
}

{
if (self::$zendLoaded) {
return;
}

set_include_path(
);
}
}



{
Framework Zend dans
lib/vendor/Zend
{
}

Initialisation de
{
if (self::$zendLoaded) { l’autoloader de Zend
return;
}

set_include_path(
);
}
}



Création d’un module et d’une route

❖ Création d’un nouveau module converter

$ php symfony generate:module api converter

❖ Création d’une nouvelle route converter_service dans routing.yml

converter_service:
url: /converter/service
param: { module: converter, action: index }



class TemperatureConverterService
{
/**
* Converts a Celsius temperature into a Fahrenheit temperature.
*
* @param float $value The value to convert
* @return float
*/
public function convertCelsiusToFahrenheit($value)
{
return 1.8 * $value + 32;
}

/**
* Converts a Fahrenheit temperature into a Celsius temperature.
*
* @param float $value The value to convert
* @return float
*/
public function convertFahrenheitToCelsius($value)
{
return (5/9) * $value - 160/9;
}
} PHPDoc importante



Dévoiler le WSDL

public function executeWsdl(sfWebRequest $request)
{
try
{
$wsdl = new Zend_Soap_AutoDiscover();
$wsdl->setClass('TemperatureConverterService');
$wsdl->handle();
}
catch (Exception $e)
{
$this->logMessage($e->getMessage());
}

}



Dévoiler le WSDL

public function executeWsdl(sfWebRequest $request)
{
try
{
$wsdl = new Zend_Soap_AutoDiscover();
$wsdl->setClass('TemperatureConverterService');
$wsdl->handle();
}
{
}

return sfView::NONE; Zend génère le WSDL par
} introspection de la PHPDoc
de la classe du service



http://api.domain.com/converter/service?wsdl



Implémenter la passerelle du service

public function executeIndex(sfWebRequest $request)
{
$this->forwardIf(null !== $request->getParameter('wsdl'), 'converter', 'wsdl');

try
{
$wsdl = $this->generateUrl('converter_service', array(), true).'?wsdl';
$server = new Zend_Soap_Server($wsdl);
$server->setClass('TemperatureConverterService');
$server->setReturnResponse(true);
$this->renderText($server->handle());
}
{
}

}



Consommer le service SOAP



Consommer le service SOAP

try
{
$client = new Zend_Soap_Client(
'http://api.domain.com/converter/service?wsdl'
);

$celsiusToFahrenheit = $client->convertCelsiusToFahrenheit(30.50);
$fahrenheitToCelsius = $client->convertFahrenheitToCelsius(72.30);
}
catch (SoapFault $e)
{
exit($e->getMessage());
}

echo $celsiusToFahrenheit;
echo $fahrenheitToCelsius;



Tester le service SOAP



Tester le service SOAP

❖ Tester un service SOAP avec PHP est assez compliqué !
❖ La requête et la réponse doivent être testées
❖ Les réponses doivent être simulées (mock)

❖ Zend_Soap a l’avantage d’être déjà testé par Zend
❖ Le fonctionnement de symfony est déjà testé également
❖ A tester unitairement : la classe TemperatureConverterService



Tests unitaires du service

// test/unit/service/TemperatureConverterServiceTest.php
require dirname(__FILE__).'/../../bootstrap/unit.php';

$t = new lime_test(3);
$service = new TemperatureConverterService();

$t->diag('->convertCelsiusToFahrenheit()');

$result = $service->convertCelsiusToFahrenheit(0);
$t->is($result, 32, '->convertCelsiusToFahrenheit() returns 32');

$t->is($result, 33.8, '->convertCelsiusToFahrenheit() returns 33.8');

$t->is($result, 50, '->convertCelsiusToFahrenheit() returns 50');




$ php symfony test:unit TemperatureConverterService



// test/unit/service/TemperatureConverterServiceTest.php
require dirname(__FILE__).'/../../bootstrap/unit.php';

$t = new lime_test(6);
$service = new TemperatureConverterService();

// ...

$t->diag('->convertFahrenheitToCelsius()');

$result = $service->convertFahrenheitToCelsius(0);
$t->is($result, -160/9, '->convertFahrenheitToCelsius() returns -160/9');

$result = $service->convertFahrenheitToCelsius(33.8);
$t->is($result, 1, '->convertFahrenheitToCelsius() returns 1');

$result = $service->convertFahrenheitToCelsius(50);
$t->is($result, 10, '->convertFahrenheitToCelsius() returns 10');



Questions ?

Sensio Labs recrute !

hugo.hamon@sensio.com



Exposer des services web SOAP et REST avec symfony 1.4 et Zend Framework

Recommandé

Contenu connexe

Tendances (20)

En vedette (20)

Similaire à Exposer des services web SOAP et REST avec symfony 1.4 et Zend Framework (10)

Plus de Hugo Hamon (14)

Dernier (8)

Exposer des services web SOAP et REST avec symfony 1.4 et Zend Framework