Zend Framework 2 + API

ZFDay in Kiev, 2011

Transcript

1. ZF2 + API Создание легковесного API средствами ZF2
2. !"#$%& '#()*+(,*- Richardson Maturity Level (http://goo.gl/aYlT) The REST Architectural Style (http://goo.gl/DxTPB) Separating REST Facts from Fallacies (http://goo.gl/Xik2A) Roy Fielding’s Dissertation (http://goo.gl/Q71Y) Haters gonna HATEOS (http://goo.gl/1lrLu) Vendor Specific Mime Types - RFC4288 (http://goo.gl/o0fu6)
3. ./ +0(%*) ZF Hacker Phrozn (phrozn.info) Phing (phing.info) zftalk.dev (zf.rpod.ru) @farazdagi github.com/farazdagi
4. !(*,&(,*+ 1%&'+1+ 1. !"#$%&'"(#) * API 2. !$"%+#,$"*-',% 3. ."/0-',% 4. 1%(#,$"*-',% 5. !"00%$2+-
5. 1. 2%(*)/3%$(4 0 API
6. 2'5$- $%61+3#7 API Developers, developers, developers, developers!! !"#$$ %&"'()*++*, *&-./$0/(&* 1"2/(%+"2/3 '*++4- 5&$6&*7$+.$ 0"+0(&$+/"6 6 %*&/+$&"6
7. 8)/)$"'+(3-9 $-* 8&$), . '$+39. 5&$6"+":*#3+"$ 2";'*+.$ <$+* %"''$&=0. >"#"'+4? 2/*&/
8. Decisions 84@"& %&"/"0"#* 84@"& A"&)*/* '*++4- 84@"& 0*&0*2* &*;&*@"/0.
9. 2. 2*%)&(#*%0+3#) API
10. . :); "%91)( *):4? B/" /*0"$ API Web API RESTful Web API REST vs RESTful
11. REST Refresher REST - *&-./$0/(&+4? 2/.#3 B/" /*0"$ REST? Resources vs Representations (R & R) Richardson Maturity Model (RMM)
12. ."*)1)')3#) REST Client/Server C/2(/2/6.$ 0"+/$02/* (Stateless) D'.+4? E+/$&A$?2 (Uniform Interface) F$G.&($)"2/3 (Caching) H+"9"(&"6+$6*, I.2/$)* (Layered System) F"' %" ;*%&"2( (Code on Demand)
13. 2'+3 $%61+3#7 Web API ."*)1)'#(4$7 $ R & R (Resources and their Representations) <)(+'# #$"%'46%0+3#7 HTTP "*%(%&%'+ Security HTTP !"#$%& '()*($#+* $,-($+ .$%& /$/#$01-0 '2)*1-3"1-0 4*5)$/$6 .",-)$6*1-" 7$3+- 68$%*
14. J$2(&24 . 5&$'2/*6#$+., ."*)1)'#(4$7 $ =)$,*$+;# ."*)1)'#(4$7 $ 2*)1$(+0')3#7;# Gists Module User Gist
15. <%$(,"3-) ;)(%1- GET HEAD PUT POST DELETE PATCH 9$:;3"1-" 5)"%/#*6:"1-0 )"/;)/*. <%"1#-3"1 GET, ("4 +$1#"1#*. =*!"1* )"/;)/*. >$(*6:"1-" (5$%-))"/;)/*. ?%*:"1-" )"/;)/*. <4!"1"1-" )"/;)/*.
16. >%1- $%$(%73#7 !"#$% On Success On Failure POST GET PATCH DELETE PUT 201  Created Location: 400  Bad  Request 200  OK 400  Bad  Request 404  Not  Found 200  OK 400  Bad  Request 404  Not  Found 204  No  Content 400  Bad  Request 404  Not  Found 410  Gone 204  No  Content 400  Bad  Request 404  Not  Found
17. 2*%:#) 1)(+'# ?%:&# 0@%1+ >)A#*%0+3#) ./*+/%(&+ %A#/%& .B*+3#:)3#) &%'#:)$(0+ 6+"*%$%0 >%1#*%0&+ $#;0%'%0 Cross Origin Resource Sharing JSON-P Pagination
18. API Security Authentication (Basic, Digest, HMAC, OAuth2) 8 production /"#30" SSL K$)* '#, "/'$#3+"9" '"0#*'*
19. C)*$#%33%$(4 API L*:$) +(=+* 6$&2."++"2/3? 1"@*6#$+.$ 6$&2.. 6 URI https://api.my.com/v3/customers/123 1"@*6#$+.$ %*&*)$/&* https://api.my.com/customers/123?v=3 E2%"#3;"6*+.$ HTTP-;*9"#"60"6 ?
20. C)*$#7 0 URI @A%/*(*3+* :( B*:*%"/ :) https://api.my.com/v3.0/customer/123 ====> GET  /v3.0/customer/123  HTTP/1.1 Accept:  application/json <==== HTTP/1.1  200  OK Content-­‐Type:  application/json {    "customer":  {          "version":  "0.3",          "name":  "Sasha  Beliy"    } } https://api.my.com/customer/123 ====> GET  /customer/123  HTTP/1.1 Accept:  application/vic.myapp-­‐v3+json <==== HTTP/1.1  200  OK Content-­‐Type:  application/vic.myapp-­‐v3+json {    "customer":  {          "name":  "Sasha  Beliy"    } } https://api.my.com/customer/123?format=xml ====> GET  /customer/123?format=xml  HTTP/1.1 https://api.my.com/customer/123 ====> GET  /customer/123  HTTP/1.1 Accept:  application/xml
21. 3. !%61+3#) API
22. GitHub Gists API Version 3 of the API http://developer.github.com/v3/gists/ J*22)*/&.6*$)4$ H$/"'4: POST, GET, PATCH, DELETE, PUT
23. D+6%0-) >%;"%3)3(- Zend Framework 2 ZendSkeletonModule SpiffyDoctrine Gists (+*G )"'(#3) Doctrine 2 ORM
24. C+E3-) &'+$$- Zend\Mvc\Controller\RestfulController Gists\Mvc\Controller\RestfulController Application\Http\PhpEnvironment\Request
25. =)$,*$-    User -­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐ id username gists Gist -­‐-­‐-­‐-­‐-­‐-­‐-­‐ id user description content
26. User Entity class  User {        //  skip        /**          *  @ORM\OneToMany(targetEntity="Gist",          *                                mappedBy="user")          */        protected  $gists;        //  skip }
27. Gist Entity class  Gist {        //  skip        /**          *  @ORM\ManyToOne(targetEntity="User",                                            inversedBy="gists")          */        protected  $user;                //  skip }
28. F3()*G)9$ List Get a single gist Create a gist Edit a gist Star/Unstar a gist Is a gist starred? Delete a gist GET  /gists GET  /gists/starred GET  /gists/:id POST  /gists PATCH  /gists/:id PUT  /gists/:id/star DELETE  /gists/:id/star GET  /gists/:id/star DELETE  /gists/:id
29. 2*)1$(+0')3#) &$'()# *'+("' JSON 1  { 2          "id":  42, 3          "description":  "some  description", 4          "content":  "some  content" 5  }
30. 2*)1$(+0')3#) RepresentationInterface --------------------------- - iterator + toString() JSONRepresentation UserIteratorAggregate GistIteratorAggregate XMLRepresentation FieldsIteratorAggregate ----------------------------- + getIterator()
31. Setup Controller Action /**  *  GET  /gists/:id  */ public  function  get($id) {        $gist  =  $this-­‐>getService()                                  -­‐>get($id);        $this-­‐>response-­‐>setStatusCode(200);        $repr  =  new  JsonRepresentation($gist);        return  array(                'content'  =>  $repr-­‐>toString()  );         }
32. Entity Service public  function  get($id) {        $gist  =  $this-­‐>em                                  -­‐>find('Gists\Entity\Gist',  $id);        if  ($gist)  {                $repr  =  new  GistIteratorAggregate($gist);        }        throw  NotFoundException('Not  Found'); }
33. Setup Routing return  array(        'routes'  =>  array(                'gists'  =>  array(                        'type'        =>  'Zend\Mvc\Router\Http\Regex',                        'options'  =>  array(                        'regex'      =>                                            '/gists(/(?<id>[0-­‐9]*[^/]+)?)?',                                'defaults'  =>  array(                                        'controller'  =>  'gists_index',                                ),                        ),                ),        ), );
34. 4. ?)$(#*%0+3#) API
35. ?#"- ()$(#*%0+3#7 =,:&+;#! H%1,'43%) I,3&J#%3+'43%) 8+B*,6%:3%) # $(*)$$ ()$(#*%0+3#)
36. Quick & Dirty CURL ,')-."' 3rd Party Tools (apigee.com)
37. Unit Testing >(% 3) "%3#;+)( 6+:);, (%B% "%613% $"+$+(4! Zend\Mvc\ModuleManager GistsTests\Framework\TestCase ?)$(#*,);: !)*0#$3-9 $'%9 H%1)'#
38. UTs Bootstrap use  GistsTest\Framework\TestCase; $moduleManager  =  new  \Zend\Module\Manager(array(    'SpiffyDoctrine',  'Application',  'Gists') ); $moduleManager-­‐>loadModules(); $mergedConfig  =  $moduleManager    -­‐>getMergedConfig()    -­‐>toArray(); //  sets  up  (and  exposes):   //  service  locator,  entity  manager  etc TestCase::$config  =  $mergedConfig;
39. Test Case Setup namespace  GistsTest; class  FooTest  extends  Framework\TestCase {        protected  $service;        public  function  setUp()        {                parent::setup();        //  manners                $this-­‐>service  =  $this-­‐>getLocator()                                                            -­‐>get('api');        }
40. Functional Testing /**  *  GET  /gists/:id/star  */ public  function  testIsGistStaredTrue() {        $result  =  $this-­‐>getCurl()-­‐>request(                'GET',  $gist-­‐>value  .  '/star'        );        $this-­‐>assertSame(                'HTTP/1.1  204  No  Content',                    $result['status']        ); }
41. Load Testing F3$(*,;)3(- ab siege php + curl + loop K)'4: L63+(4 (%:&, $'%;+, "%37(4 (roughly!) 3+ :(% $"%$%/)3 $)*0#$ 0 ()&,M)9 &%3G#B,*+J##
42. 5. 2%11)*E&+ API
43. N 0- 63+)(), :(% .. O#634 %:)34 ,"*%M+)($7 )$'# , 0+$ )$(4: H%6B# 2%3#;+3#) B'+0)3$(0,5M)9 "+*+1#B;- H%1,'43-) # (!) G,3&J#%3+'43-) ()$(- 8)"*)*-03+7 #3()B*+J#7
44. Extras/Closing Thoughts API Documentation Depricating P)3)*+(%*- &%1+ Never expose more than necessary
45. F$:%! Fork the project (github.com/farazdagi/zf2-rest) Slice the project Help redefining the REST in ZF2
46. THE END @farazdagi