O documento discute a arquitetura REST e como implementá-la de forma RESTful. Ele explica os principais conceitos como recursos, identidade, interface uniforme e hipermídia. Também discute como implementar REST em Java usando JAX-RS e como frameworks como o Restfulie podem facilitar a criação de aplicações HATEOAS.

1. Do REST ao RESTful
Luiz Costa
luiz.costa@caelum.com.br
@gutomcosta
Sergio Junior
sergio.junior@caelum.com.br
@sergioazevedo

2. Integração O velho problema

3. O Banco de Dados Solução Prática #1

4. Transferência de Arquivos Solução Prática #2

5. Web Services Solução Prática #3

6. Como são os Web Services hoje?
• Baseados na especificação WS-*
• Descritores WSDL
• SOAP e XML
• Utilizam um estilo RPC(Remote
Procedure Call)
Focados em Operações

7. Requisitos não Funcionais
✤ protocolo de transferência de dados amplamente utilizado
✤ escalabilidade
✤ performance alta
✤ alta disponibilidade
✤ permitir evolução sem parar o sistema
✤ permitir evolução sem quebrar clientes
✤ segurança

8. Requisitos não Funcionais
✤ http
✤ escalabilidade
✤ performance alta
✤ alta disponibilidade
✤ permitir evolução sem parar o sistema
✤ permitir evolução sem quebrar clientes
✤ segurança

9. Requisitos não Funcionais
✤ http
✤ web: caches
✤ performance alta
✤ alta disponibilidade
✤ permitir evolução sem parar o sistema
✤ permitir evolução sem quebrar clientes
✤ segurança

10. Requisitos não Funcionais
✤ http
✤ web: caches
✤ web: proxies, localização geográfica
✤ alta disponibilidade
✤ permitir evolução sem parar o sistema
✤ permitir evolução sem quebrar clientes
✤ segurança

11. Requisitos não Funcionais
✤ http
✤ web: caches
✤ web: proxies, localização geográfica
✤ http: load balancers
✤ permitir evolução sem parar o sistema
✤ permitir evolução sem quebrar clientes
✤ segurança

12. Requisitos não Funcionais
✤ http
✤ web: caches
✤ web: proxies, localização geográfica
✤ http: load balancers
✤ http: load balancers
✤ permitir evolução sem quebrar clientes
✤ segurança

13. Requisitos não Funcionais
✤ http
✤ web: caches
✤ web: proxies, localização geográfica
✤ http: load balancers
✤ http: load balancers
✤ web: html e loosely coupling
✤ segurança

14. Requisitos não Funcionais
✤ http
✤ web: caches
✤ web: proxies, localização geográfica
✤ http: load balancers
✤ http: load balancers
✤ web: html e loosely coupling
✤ tls: https

15. HTTP faz isso tudo mesmo?
Me mostre um
Exemplo

16. Web O Sistema Escalável

17. Protocolos da Internet
veronica: busca em gopher smtp: email
irc: chat
wais: busca em banco de dados
archie: busca em ftp telnet: acesso remoto
gopher, www: hipertexto
nntp: fórum de discussão
ftp: arquivos
prospero: directory services

18. E hoje?
smtp: email
bittorrent: arquivos
irc, im: chat
ssh: acesso remoto

19. home banking: www
compras: www
calendário: www
email: www
chat: www
documentos: www
conteúdo restrito: www
sexo: www

20. 2000 - Roy Fielding
why the web? why?
Do REST Ao RESTful
Www.caelum.com.br

21. REpresentational
State
Transfer
O que é isso?

22. Recursos
É algo interessante para sua
aplicação.
Fotos, relatorios, arquivos,
Lista de buracos da BR 101.
Tudo é um recurso.

23. Identidade de um Recurso
Para ser encontrado o recurso precisa ser
identificado.
Todos os clientes
http//exemplo.com/clientes
Acessando um cliente
http//exemplo.com/clientes/10
Acessando outro cliente
http//exemplo.com/clientes/23

24. Link os Recursos
Os dados do pedido junto com o cliente
<cliente>
<id> 23 </id>
<nome>Joana Cardoso</nome>
<cpf>12345678900</cpf>
<pedidos>
<pedido>
<id>1234</id>
<data> 01/10/2009</data>
<valor> 100.00 </valor>
<items>
<produto>33</produto>
<quantidade>1</quantidade>
<preco>100.00</preco>
</items>
</pedido>
</pedidos>
</cliente>

25. Link os Recursos
Os recursos devem estar ligados entre sí
<cliente>
<id>23</id>
<nome>Joana Cardoso</nome>
<cpf>12345678900</cpf>
<pedidos>
<pedido ref=’http://example.com/pedidos/
1234’ />
</pedido>
</pedidos>
</cliente>

26. Interface Uniforme Mantendo as coisas simples

27. Interface Uniforme

28. Interface Uniforme
Agora o foco são os
Recursos.

29. Interface Uniforme
Recurso /Pedidos/{Identificador}
http://exemplo.com/pedidos/10
•GET() - obtém os detalhes de um pedido específico
•PUT() - atualiza um pedido
•POST() - adiciona um item em um pedido
•DELETE() – cancela um pedido

30. Interface Uniforme
Recurso /Pedidos
http://exemplo.com/pedidos
•GET() - lista todos os pedidos
•PUT() - não é utilizado aqui
•POST() - adiciona um novo pedido
•DELETE() – não é utilizado aqui

31. Mas e se alguma coisa der errado?
Códigos de status do HTTP
•100 – Continue
•200 – OK
•201 – Created
•301 – Moved Permanently
•303 – See Other
•304 – Not Modified
•400 – Bad Request
•401 – Unauthorized
•403 – Forbidden
•404 – Not Found
•405 – Method Not Allowed
•500 – Internal Server Error

32. Representações
Atom

33. Escolhendo uma Representação
GET /pedidos/2009/11 HTTP 1.1
HOST exemplo.com
Accept: application/xml
200 OK
<pedido … />

34. Possíveis representações do recurso:
http://exemplo.com/clientes/23
XHTML XML
<html>
<body>
<dt>id</dt>
<dd>23</dd> <cliente>
<id> 23 </id>
<dt>nome</dt>
<nome>Joana Cardoso</nome>
<dd>Joana Cardoso</dd> <cpf>12345678900</cpf>
<dt>cpf</dt> </cliente>
<dd>12345678901</dd>
</body>
</html>

35. Falta de Estado Http é Stateless

36. Falta de Estado
Basicamente significa não utilizar sessões HTTP.
Sem sessões, favorecemos a escalabilidade.
Os clientes precisam aprender a viver sem sessões.

37. Escalabilidade Falta de estado pode ser bom.

38. Escalabilidade Falta de estado pode ser bom.

39. Escalabilidade Falta de estado pode ser bom.

40. Escalabilidade Falta de estado pode ser bom.

41. Escalabilidade Falta de estado pode ser bom.

42. Escalabilidade Falta de estado pode ser bom.

43. Escalabilidade Falta de estado pode ser bom.

44. Escalabilidade Falta de estado pode ser bom.

45. A solução REST para Java JSR-311 - JAX-RS

46. JAX-RS - Definindo um Recurso
@Path("/pedido/{id}")
public class PedidoResource {
@GET
@Produces( { MediaType.APPLICATION_XML,
MediaType.APPLICATION_JSON })
public Pedido getPedidoById(@PathParam("id") Long id){
PedidoDAO pedidoDAO = new PedidoDAO();
Pedido pedido = pedidoDAO.getPedidoById(id);
return pedido;
}
}

47. JAX-RS + JAX-B
Serialização Simples do Modelo
@XmlRootElement
public class Pedido {
private Long id;
private Double total;
private Calendar dataCriacao;
private enum status;
//Getters e Setters...
}

48. A vida de um recurso Nao é apenas CRUD

49. Recebi meu recurso.
Mas e agora, o que eu posso fazer com ele?
Que ações estão disponiveis para meu recurso?
Com que outros recursos eu posso interagir?

50. Recebi meu recurso.
Mas e agora, o que eu posso fazer com ele?
Que ações estão disponiveis para meu recurso?
Com que outros recursos eu posso interagir?
Template URI’s podem ajudar?

51. Os possíveis estados de um Pedido

52. O Recurso pode trazer link’s
para as proximas transições
Os Recursos agora trazem consigo:
• Dados
• Linkʼs para outros recursos (transições de estado)
Exemplo:
<?xml version="1.0" encoding="UTF-8"?>
<pedido>
<dataCriacao>2009-11-23T00:15:15Z</dataCriacao>
<id>1</id>
<total>137.00</total>
<status>unpaid</status>
<atom:link rel="cancel href="http://localhost:3000/pedido/3"/>
<atom:link rel="pay" ref="http://localhost:3000/pagamento/pedido/3"/>
</pedido>

53. O Recurso pode trazer link’s
para as proximas transições
Os Recursos agora trazem consigo:
• Dados
é a!
to di
• Linkʼs para outros recursos (transições de estado)
Is
Exemplo:
m e
e r
<?xml version="1.0" encoding="UTF-8"?>
<pedido>
p
<id>1</id>
H y
<dataCriacao>2009-11-23T00:15:15Z</dataCriacao>
<total>137.00</total>
<status>unpaid</status>
<atom:link rel="cancel href="http://localhost:3000/pedido/3"/>
<atom:link rel="pay" ref="http://localhost:3000/pagamento/pedido/3"/>
</pedido>

54. Hypermedia com JAX-RS Quebrou a firma.

55. Hypermedia com JAX-RS?
Precisamos de um Assembler de Recursos
public class PedidoXMLAssembler {
private final String LINK_BASE = "<atom:link rel="%s" href="%s"/>";
public String pedidoToXmlAtom(Pedido pedido, UriInfo uriInfo)
throws JAXBException {
JAXBContext context = JAXBContext.newInstance(Pedido.class);
Marshaller marshaller = context.createMarshaller();
StringWriter out = new StringWriter();
marshaller.marshal(pedido, out);
int idx = out.getBuffer().indexOf("</pedido>");
StringBuilder links = getAtomLinks(pedido, uriInfo);
out.getBuffer().insert(idx, links.toString());
return out.toString();
}
private StringBuilder getAtomLinks(Pedido pedido, UriInfo uriInfo) {
StringBuilder builder = new StringBuilder();
if (pedido.getStatus() == PedidoStatus.NOVO) {
builder.append(String.format(LINK_BASE, "cancel", uriInfo
.getBaseUriBuilder().path("/pedido/" + pedido.getId())
.build()));
builder.append(String.format(LINK_BASE, "pay", uriInfo
.getBaseUriBuilder().path(
"/pagamento/pedido/" + pedido.getId()).build()));
}
return builder;
}

56. Hypermedia As The Engine
Of Application State HATEOAS

57. HATEOAS - Hypermedia As The Engine
Of Application State
• Os linkʼs informam os próximos passos válidos
• Seguindo estes linkʼs interagimos com os recursos
• E assim mudamos o estado da aplicação
Após um entry point basta seguir os links
Hypermedia descreve o protocolo

58. http://restfulie.caelum.com.br/
Framework para HATEOAS Java, Ruby, c#

59. Client - Java
Order order = new Order();
// place the order
order = service("http://www.caelum.com.br/order").post(order);
// cancels it
resource(order).getTransition("cancel").execute();

60. Server - Java
public class Order implements StateResource {
public List<Transition> getFollowingTransitions(Restfulie control) {
if (status.equals("unpaid")) {
control.transition("latest").
uses(OrderingController.class).get(this);
control.transition("cancel").
uses(OrderingController.class).cancel(this);
}
return control.getTransitions();
}
}

61. Client - Ruby
# retrieves the resource through GET: the entry point
order = Order.from_web resource_uri
puts "Order price is #{order.price}"
# sends a post request to create a payment
order.pay payment
# sends a delete request
order.cancel

62. Server - Ruby
class Order < ActiveRecord::Base
acts_as_restfulie do |transitions|
transitions << [:show]
transitions << [:destroy] if can_cancel?
transitions << [:controller => :payments,
:action => :create,
{:id => id}] if can_pay?
end
end

63. Obrigado. Luiz Costa
luiz.costa@caelum.com.br
@gutomcosta
Sergio Junior
sergio.junior@caelum.com.br
@sergioazevedo