O documento apresenta os sete pecados capitais na exposição de APIs RESTful, sendo eles: soberba, luxúria, ira, avareza, inveja, gula e preguiça. O autor descreve cada um desses pecados com exemplos de más práticas na construção e manutenção de APIs, e propõe algumas estratégias para evitá-los, como documentação interativa, versionamento, monitoramento de métricas e suporte ao desenvolvedor.

1. Kleber
Bacili
kleber.bacili@sensedia.com
@kleberbacili
Os
7
pecados
capitais
na
exposição
de
APIs
RESTful

2. www.slideshare.net/kleberbacili/

3. Kleber
Bacili
kleber.bacili@sensedia.com
@kleberbacili

4. v SOA,
Microservices
e
APIs
v Projetos
bacaníssimos
v Ferramentas
sensacionais
v Headquarter
em
Campinas,
escritórios
em
SP,
Rio
e
EUA

5. Alguns
Clientes

6. As
APIs
estão
por
toda
parte…

7. Fonte:
ProgrammableWeb
Clube
dos
Bilionários
5+
Bilhões
de
Calls/Dia
1+
Bilhões
de
Calls/Dia

8. Clube
dos
Bilionários
1.1
billion
API
calls
/
day
(April
2011)
1.4
billion
API
calls
/
day
(May
2012)
1
billion
API
calls
/
day
(Mar
2012)
13
billion
API
calls
/
day
(May
2011)
Approx.
75%
of
all
traffic
via
API
5
billion
API
calls
/
day
(October
2009)
5
billion
API
calls
/
day
(April
2010)
Fonte:
ProgrammableWeb
Founder
7,2
bilion
API
calls
(Mar/2015)

9. Startup
BaXlefield
78%

10. Open
Banking?

11. Agenda
Os
7
Pecados
Como
evitá-­‐los

12. PECADOS
CAPITAIS7

13. SOBERBA
LUXÚRIA
IRA
AVAREZA
INVEJA
GULA
PREGUIÇA
Um
histórico
cheio
de
conveniências:
v Pros`tuição
v Vaidade
v Fornicação
v Indolência
v Melancolia

14. 1995
Brad Pitt
Morgan Freeman
Gwyneth Paltrow
Kevin Spacey
David Fincher
(Clube da Luta, House of Cards, Social Network…)

15. Preguiça
Ira
Luxúria
Avareza
Inveja
Gula
Soberba

16. INVEJA1

17. Valor
ques`onável
“Todo mundo tem API,
também vou nessa!”

18. “Você
pode
até
passar
batom
num
porco,
mas
ele
con`nuará
sendo
um
porco!”

19. API
First
APIs
v Estratégia
de
Produto
/
Modelo
de
Negócio
v Experiências
MulL-­‐devices
v Parceiros
externos
e
Clientes
v Integrações
OnPremise–Cloud

20. PREGUIÇA2

21. Design
Mequetrefe
“Aplique conceitos RESTful”

22. § Código
Legado
§ SOAP
Services
§ Tabelas
de
Banco
Design
Mequetrefe

23. Coleção
/pedidos!
Resources
Elemento
/pedidos/{id}!

24. /getAccount!
/getAllAccounts!
/createDirectory!
/updateGroupName!
/findClientById!
RPC?

26. GET /vendas/pedidos!
POST /clientes/98W3G32K01/enderecos!
{…}
PUT /clientes/98W3G32K01/enderecos/1!
{…}
DELETE /users/98W3G32K01/photos!
PATCH /users/98W3G32K01 !
{…}

28. 200!
400!
500!
Resultado
OK
Erro
no
Client
Erro
no
Server

29. STATUS
OK 200!

30. GET /items?q=macbook+air+new
{!
"results" : [ !
{!
"id" : 123,!
"name" : "Macbook Air 2010 LIKE NEW", !
"price" : "499" !
}!
]!
}
SEM
Hypermedia

31. COM
Hypermedia
GET /items?q=macbook+air+new
{!
"results" : [ !
{
"_links" : [!
{"rel": "self","uri": "/items/123" },!
{"rel": "bids","uri": "/items/123/bids" },!
{"rel": "win","uri": "/items/123/bids?q=win" } !
],!
"name" : "Macbook Air 2010 LIKE NEW",!
"price" : "499"
}!
]!
}

32. Mais
informações?
Vídeo
do
Webinar
hXp://downloads.sensedia.com/webinar-­‐design-­‐de-­‐apis-­‐res[ul

33. LUXÚRIA3

34. Segurança
8
ou
80
“Nem
ligeiramente
escondido
nem
super
complexo”

35. Auten`cação
/
Autorização
Privacidade
Integridade
Disponibilidade
Auditoria

36. Básico
Intermediário
Crí`co
v Open?
v Informações
Sensíveis?
v Transações?

37. Usuários
Apps
Basic
HTTP
OAuth2
OpenID
Connect
Estratégias
de
Auten`cação
/
Autorização
App
Token

40. Definição
de
Escopo

42. Revogação
de
Token

43. Os
Fundamentos
da
Segurança
de
APIs
WEBINAR
hXp://downloads.sensedia.com/webinar-­‐seguranca-­‐de-­‐apis

44. AVAREZA4

45. Dificultar
a
vida
do
Dev
“Saia da frente e deixe o
dev trabalhar”

46. Docs
incompletos,
desatualizados,
está`cos
e
com
PDFs
de
200
páginas

47. Sign-­‐up
e
Tokens
de
acesso
automá`cos
stripe.com/docs!

48. Geong
Started
www.twilio.com/docs!

49. Documentação
Intera`va
desenvolvedores.extra.com.br!

50. Exemplos
de
código
na
linguagem
do
developer
sendgrid.com/docs!

51. REST
Console
ou
Sandbox
/
Playgroung
dev.transparencia.org.br!

52. UX
(Developer
Experience)
DX

53. GULA5

54. Entregar
API
instável
Negócios podem ser
montados sobre sua API”

55. Eat
you
own
DOG FOOD

56. Powered
by
Saiba
antes
que
SEU CLIENTE

57. Client
Apps
APIs
Rate
Limi`ng
Policy
JSON
Threat
Policy
Payload
Size
Policy
IP
Filtering
Policy
…
API
Gateway
Powered
by

58. IRA6

59. Irritar
os
Devs
“Não quebre os apps
dos seus parceiros”

60. THINGS
CHANGE!
v1
v2
v3
v4

61. Versionamento
Versão
URI:
https://api.mycompany.com/name-of-api/v2/resource!
HTTP
ou
HTTPS
Seu
domínio
Nome
da
API
(opcional)
Recursos
e
Parâmetros

62. Foruns
de
discussão
e
Abertura
de
`ckets
desenvolvedores.extra.com.br!

63. Powered
by
Troubleshoo`ng
E SUPORTE

64. SOBERBA7

65. Dirigir
de
olhos
fechados
“Para quem não sabe onde quer
chegar, qualquer caminho serve”

66. 13
bilhões
de
chamadas/dia
5
bilhões
de
chamadas/dia
5
bilhões
de
chamadas/dia
VAIDADE?

67.
Desenvolvedores
#
total
#
devs
aLvos
taxa
de
retenção
Serviço
performance
taxa
de
erros
disponibilidade
Negócios
faturamento
market
share
custos
totais
Marke`ng
#
registro
de
devs
origem
do
tráfego
métricas
de
evento
Estrutura
estabilidade
maturidade
taxa
de
mudanças
Inovação
#
produtos
#
apps
tempo
até
vender
Comunidade
mídias
sociais
aLvidade
dos
fóruns
taxa
de
crescimento
Canal
origem
das
chamadas
faturamento
por
canal
Tráfego
#
chamadas
#
abusos
de
cota
recursos
mais
usados
hNp://www.slideshare.net/Sensedia/indicadores-­‐para-­‐ap-­‐is

68. www.sensedia.com/br!
Definição
de
indicadores,
Monitoramento
e
Alertas

70. 7 SOBERBA
3 LUXÚRIA
6 IRA
4 AVAREZA
1 INVEJA
5 GULA
2 PREGUIÇA
Valor questionável
Segurança 8 ou 80
Design Mequetrefe
Dirigir de olhos fechados
Irritar os Devs
Dificultar a vida do Dev
Entregar a API Instável

71. Kleber
Bacili
kleber.bacili@sensedia.com
@kleberbacili
Os
7
pecados
capitais
na
exposição
de
APIs
RESTful
www.slideshare.net/kleberbacili/