Maturidade de APIs REST

Transcript

1. C o m p u t e r o n t h e B e a c h MATURIDADE DE APIS REST Brian Storti Pedro Vereza
2. O QUE É REST ? 2
3. O QUE É REST? ▫︎Recurso ▫︎Algo importante o suficiente para ser referenciado ▫︎Entidades ▫︎Representação ▫︎O estado de um recurso em determinado momento ▫︎REST ▫︎Não é um framework ▫︎Não é um protocolo ▫︎É um estilo arquitetural 3
4. MODELO DE MATURIDADE Leonard Richardson, 2008 4
5. MODELO DE MATURIDADE 5
6. NIVEL 0 Uma URL e um método HTTP 6
7. NIVEL 0 ▫︎Um método HTTP ▫︎Uma URL ▫︎Tudo no payload ▫︎Independe do formato ▫︎SOAP 7 POST /eventoService HTTP/1.1 <openSlotRequest trilha = "arquitetura" data = "16-10-2014" duracao = "15"/> HTTP/1.1 200 OK <openSlotList> <slot start = "1655" end = "1710"> <trilha id = "arquitetura"/> </slot> </openSlotList> POST /eventoService HTTP/1.1 <reserveSlotRequest trilha = "arquitetura" data = "16-10-2014" duracao = “15" nome = "Maturidade de APIs REST"/>
8. NIVEL 1 Várias URLs e um método HTTP 8
9. NIVEL 1 ▫︎Um método HTTP ▫︎Várias URLs ▫︎URI Tunneling ▫︎HTTP como camada de transporte 9 POST /getOpenSlots HTTP/1.1 <openSlotRequest trilha = "arquitetura" data = "16-10-2014" duracao = "15"/> POST /reserveSlot? trilha=arquitetura&date=16-10-2014 &nome=Maturidade-API-REST HTTP/1.1 HTTP/1.1 200 OK <openSlotResponse> <slot start = "1655" end = "1710"> <trilha id = "arquitetura"/> </slot> <openSlotResponse/>
10. NIVEL 2 Uso adequado do HTTP 10
11. NIVEL 2 ▫︎Várias URLs ▫︎Uso adequado dos métodos HTTP (RFC 2616) 11 GET /openSlots? trilha=arquitetura&data=16-10-2014 &duracao=15 HTTP/1.1 POST /reserveSlot? trilha=arquitetura&date=16-10-2014 &nome=Maturidade-API-REST HTTP/1.1 HTTP/1.1 200 OK <openSlotResponse> <slot start = "1655" end = "1710"> <trilha id = "arquitetura"/> </slot> <openSlotResponse/> HTTP/1.1 201 Created Location: /palestras/1234
12. 12 NIVEL 3 Hypermedia
13. NIVEL 3 ▫︎Hypermedia ▫︎Hypermedia ▫︎Hypermedia 13 GET /openSlots HTTP/1.1 HTTP/1.1 200 OK <openSlotResponse> <link href="api.evento.com/slot/1" rel = "reserve.slot" > <slot id=1 start="1655" end="1710"> <trilha id="arquitetura"/> </slot> <openSlotResponse/> GET api.evento.com HTTP/1.1 200 OK <link href=“api.evento.com/openSlots” rel= "open.slots"/> <link href= "api.evento.com/slots" rel= "all.slots"/>
14. NETFLIX 14 <catalog_title_index> <title_index_item> <id>http://api-public.netflix.com/catalog/titles/movies/512381</id> <updated>1217404229</updated> <link href="http://api-public.netflix.com/catalog/people/20001977" rel="http://schemas.netflix.com/catalog/person.actor" title="Anna Paquin"/> <link href="http://api-public.netflix.com/catalog/people/23599" rel="http://schemas.netflix.com/catalog/person.actor" title="Dana Delany"/> <link href="http://api-public.netflix.com/catalog/people/21741" rel="http://schemas.netflix.com/catalog/person.actor" title="Jeff Daniels"/> <release_year>1996</release_year> <link href="http://www.netflix.com/Movie/Fly_Away_Home/512381" rel="alternate" title="web page"/> <external_ids> <id rel="http://schemas.netflix.com/catalog/id.upc">0043396824393</id> <id rel="http://schemas.netflix.com/catalog/id.upc">0043396060463</id> </external_ids> </title_index_item> </catalog_title_index>
15. "Se o estado da aplicação não está sendo controlado por hypermedia, então ela não pode ser chamada de RESTful. Ponto. Existe algum manual quebrado em algum lugar que precisa ser arrumado?” Roy Fielding, 2008 15
16. MUITO BONITO, MAS Por que não existem muitos serviços nível 3? 16
17. HAL+JSON 17
18. HAL+JSON 18
19. MODELO DE MATURIDADE 19 Uma URL, um método HTTP Várias URLs, um método HTTP Uso adequado do HTTP Hypermedia
20. BOAS PRÁTICAS 20
21. CONHECERÁS TEUS VERBOS Saiba o que sua aplicação está dizendo 21
22. 22 RFC 2616
23. CARACTERÍSTICAS DE MÉTODOS HTTP ▫︎Idempotência ▫︎Operação pode ser repetida várias vezes e sempre terá o mesmo resultado. ▫︎Segurança ▫︎Nenhum efeito colateral é causado. 23
24. MÉTODOS HTTP 24 Método Idempotente Seguro Uso GET Sim Sim Leitura DELETE Sim Não Remoção POST Não Não Criação/Atualização PUT Sim Não Criação/Atualização
25. 25 RFC 2616
26. “Se a URL requisitada não aponta para um recurso existente, e esta URL pode ser definida como um novo recurso, o servidor pode criá-lo nessa URL” RFC 2616 sobre PUT 26
27. CADA CASO É UM CASO 27
28. NÃO PERDERÁS TEMPO Cache 28
29. CACHE 29
30. A requisição mais rápida é a requisição que não é feita. 30
31. CACHE 31
32. DIRÁS A VERDADE 32
33. STATUS CODE ▫︎1xx - Informação ▫︎2xx - Sucesso ▫︎3xx - Redirecionamento ▫︎4xx - Erro do cliente ▫︎5xx - Erro do servidor 33
34. DIRÁS A VERDADE 34
35. ABRAÇARÁS A WEB 35
36. A web é o sistema distribuído mais bem sucedido existente. 36
37. Brian Storti www.brianstorti.com brian.storti@thoughtworks.com Pedro Vereza www.pedrovereza.com pedro.vereza@thoughtworks.com OBRIGADO