Um pouco sobre REST

Apresentação de alguns padrões de uma Arquitetura REST

Transcript

1. Arquitetura Rest Revisitando
2. • Social - Pessoas estão compartilhando tudo a todo tempo. • Mobile - Usuário compartilha muito a todo momento usando Celular/IoT. • Cloud - Tudo rodando em algum lugar de maneira simples e escalável • Information - Tudo isso gera Informação
3. Mattheus Cassundé cassunde.github.io github.com/cassunde linkedin.com/in/cassunde twitter.com/MattheusCassund dev.to/cassunde
4. Application Programming Interface
5. • Simplificar Integrações • Impulsionar Novos negócios Application Programming Interface
8. API
9. API
10. Representational State Transfer REST
11. Representational State Transfer REST RESTful Segue firme os conceitos do REST
12. Request Response
13. ENDEREÇO CABEÇALHO CORPO Request Response
14. ENDEREÇO CABEÇALHO CORPO CABEÇALHO CORPO STATUS Request Response
15. • URI • Recursos • Operações • Versionamento • Media Types • Status & Erros Code • Filtro e Paginações • Segurança (Inicial) 8 Padrões
16. URL & URI
17. URL & URI https://localhost:8080/restfulservice/v1/orders/{id}
18. URL & URI https://localhost:8080/restfulservice/v1/orders/{id}
19. URL & URI https://localhost:8080/restfulservice/v1/orders/{id}
20. Recursos
21. Funcionalidades bem definidas oferecidas pela API Recursos
23. Escutar música nas rádios
24. Escutar música nas rádios
25. Aumentar o volume Mudar estação Escutar música nas rádios
26. Aumentar o volume Mudar estação Escutar música nas rádios api
27. Aumentar o volume Mudar estação Escutar música nas rádios recurso recurso api
28. • Criar pedido • Cancelar pedido • Buscar pedido • Atualizar um pedido API Pedidos
29. • Criar pedido • Cancelar pedido • Buscar pedido • Atualizar um pedido API Pedidos • /order • /order/{id}/cancel • /order • /order/{id}
30. • Criar pedido • Cancelar pedido • Buscar pedido • Atualizar um pedido API Pedidos • /order • /order/{id}/cancel • /order • /order/{id}
31. • Criar cancelamento • Confirma cancelamento • Buscar cancelamento API Cancelamento de Pedidos
32. • Criar cancelamento • Confirma cancelamento • Buscar cancelamento API Cancelamento de Pedidos • /cancel • /cancel/{id}/confirm • /cancel/{id}
33. Operações
34. Operações GET POST PUT PATCH DELETE
35. Operações - Verbos HTTP RECURSO GET POST PUT PATCH DELETE /order Retornar todos os pedidos Criar um pedido NADA NADA NADA /order/123 Retorna pedido 123 NADA Atualiza todo pedido Atualiza parte do pedido Remove pedido 123
36. POST - Criação POST /orders
37. { "product":"beer", "amount": 10 } POST - Criação POST /orders
38. { "product":"beer", "amount": 10 } POST - Criação POST /orders { "id":"12313132131312" } Response
39. { "product":"beer", "amount": 10 } POST - Criação POST /orders { "id":"12313132131312" } Response Identificador do recurso recém criado
40. GET /orders GET - Resgate
41. GET /orders no body GET - Resgate
42. [ { "id":"12313132131312" "product": "beer", "amount": 15, "sentEmail" : false, "taxed": true } ] GET /orders no body GET - Resgate Response
43. [ { "id":"12313132131312" "product": "beer", "amount": 15, "sentEmail" : false, "taxed": true } ] GET /orders no body GET - Resgate Response
44. [ { "id":"12313132131312" "product": "beer", "amount": 15, "sentEmail" : false, "taxed": true } ] GET /orders no body GET - Resgate Response
45. GET /orders/010101 no body GET - Resgate
46. GET /orders/010101 no body GET - Resgate Identificador do recurso recém criado
47. { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true } GET /orders/010101 no body GET - Resgate Response Identificador do recurso recém criado
48. PUT /orders/010101 PUT - Atualização completa
49. { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true } PUT /orders/010101 PUT - Atualização completa
50. PATCH /orders/010101 PATCH - Atualização parcial
51. { "status": "PAID" } PATCH /orders/010101 PATCH - Atualização parcial
52. DELETE DELETE /orders/010101
53. Versionamento
54. • Todo software evolui • Garantir Retrocompatibilidade Versionamento
55. https://localhost:8080/restfulservice/v1/orders/{id}
56. https://localhost:8080/restfulservice/v1/orders/{id} Protocolo host port serviço versão recurso parâmetro
57. https://localhost:8080/restfulservice/v1/orders/{id} versão
58. API
59. API ? ?
60. API ? ?
61. API
62. API ? ?
63. API
64. API v1
65. API v1 API v2
66. API v2 API v2
67. Media Type
68. Formatos Padronizados • application/json • application/xml Media Type Request • Accept: application/json Response • Content-type: application/json
69. Status & Error Code
70. • 100 - Informação • 200 - Resultado OK • 300 - Redirecionamento • 400 - Erro no Client • 500 - Erro no Server Status & Error Code
71. POST - Criação POST /orders
72. { "product":"beer", "amount": 10 } POST - Criação POST /orders
73. { "product":"beer", "amount": 10 } POST - Criação POST /orders { "id":"12313132131312" } Status code - 201 - Created
74. [ { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true } ] GET /orders no body GET - Resgate Status code - 200 - Ok
75. [] GET /orders no body GET - Resgate Status code - 204 - No Content
76. GET /orders/010101 no body GET - Resgate
77. GET /orders/010102 no body GET - Resgate Status code - 404 - Not Found no body
78. { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true } PUT /orders/010101 PUT - Atualização completa
79. { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true } PUT /orders/010101 PUT - Atualização completa Status code - 200 / 204 no body
80. { "status": "PAID" } PATCH /orders/010101 PATCH - Atualização parcial
81. { "status": "PAID" } PATCH /orders/010101 PATCH - Atualização parcial Status code - 200 / 204 no body
82. DELETE DELETE /orders/010101
83. DELETE DELETE /orders/010101 Status code - 200 / 204 no body
84. Filtros
85. Dependendo do recurso é inviável retornar todos os itens no GET /orders Filtros
86. Dependendo do recurso é inviável retornar todos os itens no GET /orders Mas precisamos garantir a flexibilidade Filtros
87. Filtros [ { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true }, { "product": "sanduba", "amount": 20, "sentEmail": false, "taxed": false } ]
88. Escolhemos os atributos que fazem sentido termos como filtro Filtros [ { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true }, { "product": "sanduba", "amount": 20, "sentEmail": false, "taxed": false } ]
89. Escolhemos os atributos que fazem sentido termos como filtro Filtros [ { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true }, { "product": "sanduba", "amount": 20, "sentEmail": false, "taxed": false } ]
90. GET /orders?taxed=true Filtros
91. GET /orders?taxed=true Filtros
92. GET /orders?taxed=true Filtros [ { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true } ]
93. Definir um limite de dados retornados em nossa API é importante para garantirmos nosso tempo de resposta Paginação
94. GET /orders?page=1&page_size=1 Paginação [ { "product": "beer", "amount": 15, "sentEmail": false, "taxed": true } ]
95. Básico • Sempre usar https • Nunca expor dados sensíveis na URL Segurança Avançado • Basic Authorization: Basic <credential> • JWT | Authorization: Bearer <credential> • OAuth 2.0
96. GET /orders/1 Segurança GET /orders/012012012012 sequencial UUID
97. fim Mattheus Cassundé github.com/cassunde linkedin.com/in/cassunde twitter.com/MattheusCassund https://dev.to/cassunde