.png){kind=small}
Slide 1
Slide 1 text
Simplificando APIs
REST
Slide 2
Slide 2 text
Aplicações Aplicações Aplicações
Slide 3
Slide 3 text
Aplicações Aplicações Aplicações
Slide 4
Slide 4 text
Aplicações Aplicações Aplicações
Slide 5
Slide 5 text
Aplicações Aplicações Aplicações
Slide 6
Slide 6 text
Aplicações Aplicações Aplicações
APIs APIs
Slide 7
Slide 7 text
Application Programming Interface
Slide 8
Slide 8 text
Mattheus Cassundé
Software Engineer
cassunde.com.br
Slide 9
Slide 9 text
Mattheus Cassundé
Software Engineer
cassunde.com.br
Slide 10
Slide 10 text
Mattheus Cassundé
Software Engineer
cassunde.com.br
Slide 11
Slide 11 text
Mattheus Cassundé
Software Engineer
cassunde.com.br
Slide 12
Slide 12 text
Application Programming Interface
Slide 13
Slide 13 text
● Simplificar Integrações
● Impulsionar Novos negócios
Application Programming Interface
Slide 14
Slide 14 text
● Simplificar Integrações
● Impulsionar Novos negócios
Application Programming Interface
Slide 15
Slide 15 text
No content
Slide 16
Slide 16 text
No content
Slide 17
Slide 17 text
API
Slide 18
Slide 18 text
API
Slide 19
Slide 19 text
API
Slide 20
Slide 20 text
Aplicações
Aplicações
n…
API
Slide 21
Slide 21 text
REST
Slide 22
Slide 22 text
Representational State Transfer
REST
Slide 23
Slide 23 text
Representational State Transfer
REST
RESTful
Segue firme os conceitos do REST
Slide 24
Slide 24 text
Representational State Transfer
REST
RESTful
Segue firme os conceitos do REST
Slide 25
Slide 25 text
Request Response
Slide 26
Slide 26 text
ENDEREÇO
CABEÇALHO
CORPO
Request Response
Slide 27
Slide 27 text
ENDEREÇO
CABEÇALHO
CORPO
CABEÇALHO
CORPO
STATUS
Request Response
Slide 28
Slide 28 text
Request Response
aplicação
aplicação
Slide 29
Slide 29 text
Request Response
aplicação
aplicação
cliente servidor
Slide 30
Slide 30 text
Request Response
aplicação
sua aplicação
Slide 31
Slide 31 text
Request
Response
aplicação
sua aplicação
Slide 32
Slide 32 text
Response
aplicação
sua aplicação
Request
Slide 33
Slide 33 text
● URI
● Recursos
● Operações
● Versionamento
● Media Types
● Status & Erros Code
● Filtro e Paginações
● Segurança (Inicial)
8 Padrões
Slide 34
Slide 34 text
● URI
● Recursos
● Operações
● Versionamento
● Media Types
● Status & Erros Code
● Filtro e Paginações
● Segurança (Inicial)
8 Padrões
Slide 35
Slide 35 text
URL & URI
Slide 36
Slide 36 text
URL & URI
https://localhost:8080/suaplicacao/v1/orders/{id}
Slide 37
Slide 37 text
URL & URI
https://localhost:8080/suaplicacao/v1/orders/{id}
Slide 38
Slide 38 text
URL & URI
https://localhost:8080/suaplicacao/v1/orders/{id}
URI
Slide 39
Slide 39 text
URL & URI
https://localhost:8080/suaplicacao/v1/orders/{id}
URI
HOST
Slide 40
Slide 40 text
URL & URI
https://localhost:8080/suaplicacao/v1/orders/{id}
URI
HOST
Slide 41
Slide 41 text
URL & URI
https://localhost:8080/suaplicacao/v1/orders/{id}
URI
URL
HOST
Slide 42
Slide 42 text
● URI
● Recursos
● Operações
● Versionamento
● Media Types
● Status & Erros Code
● Filtro e Paginações
● Segurança (Inicial)
8 Padrões
Slide 43
Slide 43 text
Recursos
Slide 44
Slide 44 text
● Funcionalidades bem definidas oferecidas pela API
● Como uma instância de um objeto
Recursos
Slide 45
Slide 45 text
● Funcionalidades bem definidas oferecidas pela API
● Como uma instância de um objeto
Recursos
Slide 46
Slide 46 text
● Funcionalidades bem definidas oferecidas pela API
● Como uma instância de um objeto
○ Métodos fixos (POST, GET, PUT, DELETE)
○ Sempre o mesmo corpo nas repostas
Recursos
Slide 47
Slide 47 text
No content
Slide 48
Slide 48 text
Escutar
música nas
rádios
Slide 49
Slide 49 text
Escutar
música nas
rádios
Slide 50
Slide 50 text
Aumentar o
volume
Mudar
estação
Escutar
música nas
rádios
Slide 51
Slide 51 text
Aumentar o
volume
Mudar
estação
Escutar
música nas
rádios
api
Slide 52
Slide 52 text
Aumentar o
volume
Mudar
estação
Escutar
música nas
rádios
recurso recurso
api
Slide 53
Slide 53 text
Aumentar o
volume
Mudar
estação
Escutar
música nas
rádios
recurso recurso
api
end-point end-point
Slide 54
Slide 54 text
Recurso: Pedidos
Slide 55
Slide 55 text
● Criar pedido
● Cancelar um pedido
● Buscar um pedido
● Atualizar um pedido
Recurso: Pedidos
Slide 56
Slide 56 text
● Criar pedido
● Cancelar um pedido
● Buscar um pedido
● Atualizar um pedido
Recurso: Pedidos
● /orders
Slide 57
Slide 57 text
● Criar pedido
● Cancelar um pedido
● Buscar um pedido
● Atualizar um pedido
Recurso: Pedidos
● /orders
Slide 58
Slide 58 text
● Criar pedido
● Cancelar um pedido
● Buscar um pedido
● Atualizar um pedido
Recurso: Pedidos
● /orders
● /orders/{id}
● /orders/{id}
● /orders/{id}
Slide 59
Slide 59 text
● Criar pedido
● Cancelar um pedido
● Buscar um pedido
● Atualizar um pedido
Recurso: Pedidos
● /orders
● /orders/{id}
● /orders/{id}
● /orders/{id}
Slide 60
Slide 60 text
Criar pedido
Slide 61
Slide 61 text
Criar pedido __?__ /orders
Slide 62
Slide 62 text
Criar pedido __?__ /orders
Slide 63
Slide 63 text
Criar pedido POST /orders
Slide 64
Slide 64 text
Sempre retorna um
identificador
Criar pedido POST /orders
Slide 65
Slide 65 text
Sempre retorna um
identificador
Criar pedido
Slide 66
Slide 66 text
Sempre retorna um
identificador
Criar pedido
Slide 67
Slide 67 text
Sempre retorna um
identificador
Criar pedido
Slide 68
Slide 68 text
Sempre retorna um
identificador
Criar pedido
Slide 69
Slide 69 text
Sempre retorna um
identificador
Criar pedido
Slide 70
Slide 70 text
Sempre retorna um
identificador
Criar pedido
Slide 71
Slide 71 text
Sempre retorna um
identificador
Criar pedido
Slide 72
Slide 72 text
Sempre retorna um
identificador
Criar pedido
Slide 73
Slide 73 text
● Criar pedido
● Cancelar um pedido
● Buscar um pedido
● Atualizar um pedido
Recurso: Pedidos
● /orders
● /orders/{id}
● /orders/{id}
● /orders/{id}
Slide 74
Slide 74 text
● URI
● Recursos
● Operações
● Versionamento
● Media Types
● Status & Erros Code
● Filtro e Paginações
● Segurança (Inicial)
8 Padrões
Slide 75
Slide 75 text
Operações
Slide 76
Slide 76 text
Operações - Verbos HTTP
GET POST PUT PATCH DELETE
Slide 77
Slide 77 text
Operações - Verbos HTTP
GET POST PUT PATCH DELETE
Buscas
Slide 78
Slide 78 text
Operações - Verbos HTTP
GET POST PUT PATCH DELETE
Buscas Criação
Slide 79
Slide 79 text
Operações - Verbos HTTP
GET POST PUT PATCH DELETE
Buscas Criação
Atualiza todo
o objeto
Slide 80
Slide 80 text
Operações - Verbos HTTP
GET POST PUT PATCH DELETE
Buscas Criação
Atualiza todo
o objeto
Atualiza uma
parte do objeto
Slide 81
Slide 81 text
Operações - Verbos HTTP
GET POST PUT PATCH DELETE
Buscas Criação
Atualiza todo
o objeto
Atualiza uma
parte do objeto
Remove um
objeto
Slide 82
Slide 82 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
/orders/123
Slide 83
Slide 83 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
/orders/123
Slide 84
Slide 84 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
Criar um
pedido
/orders/123
Slide 85
Slide 85 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
Criar um
pedido
NADA
/orders/123
Slide 86
Slide 86 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
Criar um
pedido
NADA NADA NADA
/orders/123
Slide 87
Slide 87 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
Criar um
pedido
NADA NADA NADA
/orders/123
Retorna
pedido 123
Slide 88
Slide 88 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
Criar um
pedido
NADA NADA NADA
/orders/123
Retorna
pedido 123
NADA
Slide 89
Slide 89 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
Criar um
pedido
NADA NADA NADA
/orders/123
Retorna
pedido 123
NADA
Atualiza todo
pedido 123
Slide 90
Slide 90 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
Criar um
pedido
NADA NADA NADA
/orders/123
Retorna
pedido 123
NADA
Atualiza todo
pedido 123
Atualiza uma
parte do
pedido 123
Slide 91
Slide 91 text
Operações - Verbos HTTP
RECURSO GET POST PUT PATCH DELETE
/orders
Retornar
todos os
pedidos
Criar um
pedido
NADA NADA NADA
/orders/123
Retorna
pedido 123
NADA
Atualiza todo
pedido 123
Atualiza uma
parte do
pedido 123
Remove o
pedido 123
Slide 92
Slide 92 text
POST - Criação
POST /orders
Slide 93
Slide 93 text
{
"product":"beer",
"amount": 10
}
POST - Criação
POST /orders
Slide 94
Slide 94 text
{
"product":"beer",
"amount": 10
}
POST - Criação
POST /orders
{
"id":"12313132131312"
}
Response
Slide 95
Slide 95 text
{
"product":"beer",
"amount": 10
}
POST - Criação
POST /orders
{
"id":"12313132131312"
}
Response
Identificador do recurso
recém criado
Slide 96
Slide 96 text
GET /orders
GET - Resgate
Slide 97
Slide 97 text
GET /orders
no body
GET - Resgate
Slide 98
Slide 98 text
[
{
"id":"12313132131312"
"product": "beer",
"amount": 15,
"sentEmail" : false,
"taxed": true
}
]
GET /orders
no body
GET - Resgate
Response
Slide 99
Slide 99 text
[
{
"id":"12313132131312"
"product": "beer",
"amount": 15,
"sentEmail" : false,
"taxed": true
}
]
GET /orders
no body
GET - Resgate
Response
Slide 100
Slide 100 text
GET /orders/010101
no body
GET - Resgate
Slide 101
Slide 101 text
GET /orders/010101
no body
GET - Resgate
Identificador do recurso
recém criado
Slide 102
Slide 102 text
{
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
GET /orders/010101
no body
GET - Resgate
Response
Identificador do recurso
recém criado
Slide 103
Slide 103 text
PUT /orders/010101
PUT - Atualização completa
Slide 104
Slide 104 text
{
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
PUT /orders/010101
PUT - Atualização completa
Slide 105
Slide 105 text
PATCH /orders/010101
PATCH - Atualização parcial
Slide 106
Slide 106 text
{
"status": "PAID"
}
PATCH /orders/010101
PATCH - Atualização parcial
Slide 107
Slide 107 text
DELETE
DELETE /orders/010101
Slide 108
Slide 108 text
● URI
● Recursos
● Operações
● Versionamento
● Media Types
● Status & Erros Code
● Filtro e Paginações
● Segurança (Inicial)
8 Padrões
Slide 109
Slide 109 text
Versionamento
Slide 110
Slide 110 text
● Todo software evolui
● Garantir Retrocompatibilidade
Versionamento
Slide 111
Slide 111 text
https://localhost:8080/restfulservice/v1/orders/{id}
Slide 112
Slide 112 text
https://localhost:8080/restfulservice/v1/orders/{id}
Protocolo host port serviço versão recurso parâmetro
Slide 113
Slide 113 text
https://localhost:8080/restfulservice/v1/orders/{id}
versão
Slide 114
Slide 114 text
GET /v1/orders/12345
Slide 115
Slide 115 text
GET /v1/orders/12345
{
"id":"12313132131312"
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
Slide 116
Slide 116 text
GET /v1/orders/12345
● Payload
{
"id":"12313132131312"
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
Slide 117
Slide 117 text
GET /v1/orders/12345
● Payload
● Contrato
{
"id":"12313132131312"
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
Slide 118
Slide 118 text
GET /v1/orders/12345
{
"id":"12313132131312"
"product": {
"id":"12313132131312",
"name":"beer"
}. . .
}
Slide 119
Slide 119 text
GET /v1/orders/12345
{
"id":"12313132131312"
"product": {
"id":"12313132131312",
"name":"beer"
}. . .
}
Slide 120
Slide 120 text
GET /v1/orders/{id}
cliente 1
cliente 2
order-api
GET
/orders/1234
GET
/orders/4455
Slide 121
Slide 121 text
GET /v1/orders/{id}
cliente 1
cliente 2
order-api
GET
/orders/1234
GET
/orders/4455
Slide 122
Slide 122 text
GET /v1/orders/{id}
cliente 1
cliente 2
order-api
GET
/orders/1234
GET
/orders/4455
Slide 123
Slide 123 text
GET /v1/orders/{id}
cliente 1
cliente 2
order-api
GET
/orders/1234
GET
/orders/4455
Slide 124
Slide 124 text
{
"id":"12313132131312"
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
GET /v1/orders/{id}
Slide 125
Slide 125 text
GET /v2/orders/{id}
{
"id":"12313132131312"
"product": {
"id":"12313132131312",
"name":"beer"
}. . .
}
Slide 126
Slide 126 text
Mas esse tal de Contrato ?
Slide 127
Slide 127 text
Mas esse tal de Contrato ?
{
"id":"12313132131312"
"product": {
"id":"12313132131312",
"name":"beer"
}. . .
}
{
"id":"12313132131312"
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
V2 V1
Slide 128
Slide 128 text
OpenAPI
● Especificação de como devemos documentar nossos
contratos
Slide 129
Slide 129 text
OpenAPI
Slide 130
Slide 130 text
OpenAPI
Slide 131
Slide 131 text
OpenAPI
Slide 132
Slide 132 text
Media Type
Slide 133
Slide 133 text
Formatos Padronizados
● application/json
● application/xml
Media Type
Request
● Accept: application/json
Response
● Content-type: application/json
Slide 134
Slide 134 text
Status & Error Code
Slide 135
Slide 135 text
● 100 - Informação
● 200 - Resultado OK
● 300 - Redirecionamento
● 400 - Erro no Client
● 500 - Erro no Server
Status & Error Code
Slide 136
Slide 136 text
Status & Error Code
Slide 137
Slide 137 text
Status & Error Code
Slide 138
Slide 138 text
POST - Criação
POST /orders
Slide 139
Slide 139 text
{
"product":"beer",
"amount": 10
}
POST - Criação
POST /orders
Slide 140
Slide 140 text
{
"product":"beer",
"amount": 10
}
POST - Criação
POST /orders
{
"id":"12313132131312"
}
Status code - 201 - Created
Slide 141
Slide 141 text
{
"product":"beer",
"amount": 10
}
POST - Criação
POST /orders
Slide 142
Slide 142 text
{
"product":"beer",
"amount": 10
}
POST - Criação
POST /orders
{
"errorCode":"GBDD19"
}
Status code - 500 - Server Error
Slide 143
Slide 143 text
{
"product":"beer",
"amount": "10"
}
POST - Criação
POST /orders
Slide 144
Slide 144 text
{
"product":"beer",
"amount": "10"
}
POST - Criação
POST /orders
{
"error":"amount invalid"
}
Status code - 400 - Bad Request
Slide 145
Slide 145 text
[
{
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
]
GET /orders
no body
GET - Resgate
Status code - 200 - Ok
Slide 146
Slide 146 text
[]
GET /orders
no body
GET - Resgate
Status code - 204 - No Content
Slide 147
Slide 147 text
GET /orders/010101
no body
GET - Resgate
{
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
Status code - 200 - Ok
Slide 148
Slide 148 text
GET /orders/010102
no body
GET - Resgate
Status code - 404 - Not Found
no body
Slide 149
Slide 149 text
Filtros
Slide 150
Slide 150 text
Dependendo do recurso é inviável retornar todos os itens no
GET /orders
Filtros
Slide 151
Slide 151 text
Dependendo do recurso é inviável retornar todos os itens no
GET /orders
Mas precisamos garantir a flexibilidade
Filtros
Slide 152
Slide 152 text
Filtros
[
{
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
},
{
"product": "sanduba",
"amount": 20,
"sentEmail": false,
"taxed": false
}
]
Slide 153
Slide 153 text
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
}
]
Slide 154
Slide 154 text
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
}
]
Slide 155
Slide 155 text
GET /orders?taxed=true
Filtros
Slide 156
Slide 156 text
GET /orders?taxed=true
Filtros
Slide 157
Slide 157 text
GET /orders?taxed=true
Filtros
[
{
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
]
Slide 158
Slide 158 text
Definir um limite de dados retornados em nossa API é importante
para garantirmos nosso tempo de resposta
Paginação
Slide 159
Slide 159 text
GET /orders?page=1&page_size=1
Paginação
[
{
"product": "beer",
"amount": 15,
"sentEmail": false,
"taxed": true
}
]
Slide 160
Slide 160 text
Segurança
Slide 161
Slide 161 text
Básico
● Sempre usar https
● Nunca expor dados sensíveis na URL
Segurança
Slide 162
Slide 162 text
Básico
● Sempre usar https
● Nunca expor dados sensíveis na URL
Segurança
Avançado
● Basic Authorization: Basic
● JWT | Authorization: Bearer
● OAuth 2.0
Slide 163
Slide 163 text
GET /orders/1
Segurança
GET /orders/012012012012
sequencial
UUID
Slide 164
Slide 164 text
POST /calculate
Ações Status code - 200 - Ok
Slide 165
Slide 165 text
fim
Mattheus Cassundé
cassunde.com.br
Mattheus Cassundé
Software Engineer
@cassunde