Building Web Services with Zend Framework (PHP Benelux meeting 20100713 Vlissingen)

1. Building web services with Zend Framework King Foo Jonas Mariën 13 July 2010, Vlissingen NL

2. This talk = beta remarks and suggestions are welcome

4. 5 experienced PHP developers (4 Zend Certified Engineers, MySQL, Linux, scaling, and architecture experience

5. LAMP, but wandering off into different grounds at regular intervals Having fun with mobile stuff and web services for example ...

8. For others to consume

9. Question time Heard about / tried Zend Framework?

11. Sufficient documentation

12. MVC if you want

13. Nice server components

14. Zend Framework Download, unpack wget http://framework.zend.com/releases/ZendFramework-1.10.6/ZendFramework-1.10.6.tar.gz tar zxvf ZendFramework-1.10.6.tar.gz cp -ar ZendFramework-1.10.6/library . cp -ar ZendFramework-1.10.6/bin . alias zf=bin/zf.sh Create project, module, create controller with views zf create project . zf create module admin zf create controller index index-action-included=1 admin

15. Zend Framework You need one more thing to enable modules: resources.frontController.moduleDirectory = APPLICATION_PATH "/modules" resources.modules[] = Plus, we want our own libraries, eventually: autoloaderNamespaces.kingfoo = "Kingfoo_"

18. Add to /etc/hosts

19. Reload Apache

20. Question time Heard about / tried web services?

21. Web services From Wikipedia: Web services are typically application programming interfaces (API) or web APIs that are accessed via Hypertext Transfer Protocol (HTTP) and executed on a remote system hosting the requested services. Web services tend to fall into one of two camps: Big Web Services and RESTful Web Services.

23. XML-RPC

24. JSON-RPC

25. REST BTW, I don't want to talk about Zend_Amf

26. Exposing something class Kingfoo_Quote { public function __construct() { $array[0] = 'Chuck Norris counted to infinity - twice.'; $array[9] = 'Chuck Norris doesn’t wash his clothes, he disembowels them.'; $this->_quotes = $array; } /** * returns entire liste of quotes * @return array */ public function getList() { return $this->_quotes; } .... /** * returns a random single quote * @return string */ public function randomQuote() { $arr = $this->_quotes; shuffle($arr); return $arr[0]; } }

28. Big spec, even bigger with WS-*

29. RPC style, method oriented

30. Server and WSDL

32. SOAP governed by a W3C working group

34. The real power: WSDL generation and reflection being used for discovery

35. Strategies for discovering more complex messages and responses are available

36. Docblock comments are very important here

37. SOAP with ZF if (isset($_GET['WSDL'])) { $autodiscover = new Zend_Soap_AutoDiscover(); $autodiscover->setClass('Kingfoo_Quote'); $autodiscover->setUri('http://presentation-zfws/SOAP.php'); $autodiscover->handle(); } else { $options = array('soap_version' => SOAP_1_2); $server = new Zend_Soap_Server('http://presentation- zfws/SOAP.php?WSDL=1', $options); $server->setObject(new Kingfoo_Quote()); $server->handle(); }

39. Response

40. soapUI

42. Predecessor of SOAP

43. Limited set of datatypes, nothing like WSDL

45. That container should contain a single methodName tag

46. The method name should be a string only containin a-z,A-Z,0-9 and any of these characters: _ . : /

47. It is up to the server how to interprete this methodName

48. Parameters for the methodName being called are contained in a params tag

49. Inside the params tag, one or more param tags are listed

50. Each param tag looks like this: <param><value>...</value></param>

51. XML-RPC REQUEST: <?xml version="1.0"?> <methodCall> <methodName>zfwsdemo.getQuote</methodName> <params> <param> <value><int>2</int></value> </param> </params> </methodCall> </code> RESPONSE <code> <?xml version="1.0"?> <methodResponse> <params> <param> <value>... Chuck Norris ...</value> </param> </params> </methodResponse> </code>

54. system.* (listMethods, methodSignature, methodHelp, multicall ...)

55. XML-RPC with ZF SERVER $server = new Zend_XmlRpc_Server(); $server->setClass('Kingfoo_Quote','zfwsdemo'); echo $server->handle(); CLIENT $client = new Zend_XmlRpc_Client('http://presentation-zfws/XMLRPC.php'); //get list of methods $result = $client->call('system.listMethods'); //get a random quote $result = $client->call('zfwsdemo.randomQuote');

57. TCP/IP sockets are allowed too (not only HTTP)

58. Request, response, error object, batches

59. Client and server are peers, sending each other notifications

61. Service Message Description (SMD)

62. JSON-RPC with ZF SERVER $server = new Zend_Json_Server(); $server->setClass('Kingfoo_Quote'); $server->handle(); CLIENT $request = new stdClass(); $request->jsonrpc = '2.0'; $request->method = 'getQuote'; $request->params = array(1); $request->id = time(); $json = Zend_Json::encode($request); $client = new Zend_Http_Client('http://presentation-zfws/JSONRPC.php'); $response = $client->setRawData($json, 'application/json')->request('POST');

63. JSON-RPC with ZF AND NOW WITH SMD $server = new Zend_Json_Server(); $server->setClass('Kingfoo_Quote'); if ('GET' == $_SERVER['REQUEST_METHOD']) { $server->setTarget('/JSONRPC.php') ->setEnvelope(Zend_Json_Server_Smd::ENV_JSONRPC_2); $smd = $server->getServiceMap(); header('Content-Type: application/json'); echo $smd; return; } $server->handle();

65. Possible with Dojo too, see ZF manual

67. Resource oriented

68. XML, increasingly JSON as message format

69. HTTP verbs define nature of action on resource

70. No spec or standard, more like a 'movement'

71. RESTafarians leave funny comments on blogs and have strong opinions. True SOAP believers are a dying race, it appears. Have a laugh, Google for 'The S stands for Simple'

72. REST GET POST PUT DELETE /quotes Get list Add quote to list Update entire list Delete entire list /quotes/<id> Get quote with id <id> Add subquote (unlikely) Update single quote Delete single quote List = oftern referred to as a 'collection'

74. Now more and more integrated, using Zend_Rest_Controller and Zend_Rest_Route

75. Future versions of ZF (2.0?) will probably have it fully integrated in the controller, using context switching (see posts by Matthew Weier O'Phinney at http://weierophinney.net/matthew/)

78. protected function _initRestroutes() { $this->bootstrap('frontController'); $frontController = Zend_Controller_Front::getInstance(); $router = $frontController->getRouter(); $restRoute = new Zend_Rest_Route($frontController,array(),array('rest')); $router->addRoute('rest', $restRoute); }

79. REST with ZF Zend_Rest_Route detects HTTP verbs like POST and points them to a predefined list of corresponding URI end points. Our example code will result in behaviour like this: URI Module_Controller action GET /rest/quote/ Rest_QuoteController indexAction() GET /rest/quote/:id Rest_QuoteController getAction() POST /rest/quote Rest_QuoteController postAction() PUT /rest/quote/:id Rest_QuoteController putAction() DELETE /rest/quote/:id Rest_QuoteController deleteAction() These additional end points are supported too, as a workaround for environments where PUT or DELETE are blocked by a firewall for example: URI Module_Controller action POST /rest/quote/:id?_method=PUT Rest_QuoteController putAction() POST /rest/quote/:id?_method=DELETE Rest_QuoteController deleteAction() And that counts for every controller in the module named 'rest', as they are all considered RESTful.

80. REST with ZF SERVER -> code example: route + controller CLIENT Zend_Rest_Client -> no $client = new Zend_Http_Client('http://presentation-zfws/rest/index/2'); $response = $client->request(); echo $response->getBody();

81. REST – Response codes Error and response codes ! For example: 200 OK Everything allright 201 Created The object or resources is created 204 Empty body Resource is deleted 400 Bad Request Request is not understood or was malformed. Explanation may be available in the body . 401 Forbidden Permission denied. / credentials invalid 404 Not Found Resource could not be found. 409 Conflict/Duplicate Resource already exists 405 Method Not Allowed The action (POST, PUT, ...) is not allowed on the resource 410 Gone Resource does not/no longer exist 500 Internal server error Something went wrong on the server side 501 Not Implemented The action is not available.

83. RPC vs Resource oriented solutions

84. What do you choose? Depends on your requirements

86. What about performance?

87. Automated documentation for your peers

88. Extending the existing ZF classes and making things even more easy for yourself

89. Thanks for your time Questions? Want us to work for you? [email_address] www.king-foo.be @jonasmarien

Building Web Services with Zend Framework (PHP Benelux meeting 20100713 Vlissingen)

Building Web Services with Zend Framework (PHP Benelux meeting 20100713 Vlissingen)

Recommended

More Related Content

What's hot

What's hot(20)

Similar to Building Web Services with Zend Framework (PHP Benelux meeting 20100713 Vlissingen)

Similar to Building Web Services with Zend Framework (PHP Benelux meeting 20100713 Vlissingen)(20)

Recently uploaded

Recently uploaded(20)

Building Web Services with Zend Framework (PHP Benelux meeting 20100713 Vlissingen)