O documento discute a importância da experiência do desenvolvedor (DX) para o sucesso de APIs. A DX envolve tornar a documentação, consumo e suporte das APIs simples e rápidos através de princípios como "3:30:3", exemplos de código, sandbox e comunicação por chat. Hachathons podem acelerar o aprendizado sobre as APIs. Uma boa DX é essencial para conquistar desenvolvedores e escalar o negócio.

1. DeveloperExperience
1
Escalando negócios com a melhor
experiência ao desenvolvedor

2. 2
DavidRuiz
CTO @ PARANÁ BANCO
CO-FOUNDER @ ONOVOLAB
CO-FOUNDER @ CONCORE.IO
https://linkedin.com/in/wupsbr/
https://facebook.com/i9dvdr/

3. 3
Princípios02.
Desenho03.
Consumo04.
O que é DX?01.

4. 4
O developer experience (dx)
é trazer o usuário DEV
ao centro
DX

5. 5
À API é para o dev o que
a UI é para o usuário
comum
API’S
http://theappslab.com/2017/04/04/developer-experience-what-and-why/

6. 6
Independente de seu nível de
maturidade em API’s você
precisa se preocupar com DX
Importante
API ARCHITECTURE MATURITY MODEL
https://sensedia.com/blog/apis/modelo-de-maturidade-arquitetura-apis/

7. 7
D E S E N V O L V E D O R E S N O M U N D O
( S T A C K O V E R F L O W I N S I G H T S 2 0 1 8 )
50M
https://insights.stackoverflow.com/survey/2018

8. 8
O número de api’s cresce rapidamente
E às que possuem a melhor experiência irão vencer
https://www.programmableweb.com/news/programmableweb-api-directory-eclipses-17000-api-economy-continues-surge/research/2017/03/13

9. 9
O que é DX?
Princípios
01.
02.
Desenho03.
Consumo04.

10. 10
Princípios
do DX
De acordo com o
levantamento feito pela
Nordic, os provedores de
API’s deveriam adotar a
regra "3:30:3”:
Simples de entender
Entendimento do objetivo em
três segundos e ser capaz de
identificar os endpoints em trinta
segundos.
Rápida de consumir
Cadastramento e
experimentação (primeira
chamada) em menos de três
minutos.
Satisfação em usar
Conquistar a preferência do
desenvolvedor, tornando-a
relevante e competitiva no
mercado.
https://nordicapis.com/5-reasons-why-developers-are-not-using-your-api/

11. 11
O que é DX?01.
Consumo04.
Princípios02.
Desenho03.

12. 12
Ao especificar sua API, adote uma linguagem
agnóstica (ex: OpenAPI / APIBluePrint) que facilita
a implementação e documentação.
Preparação
Além de adotar nomes amigáveis, defina tipos
globais, busque sempre por convenções e tenha
cuidado com palavras reservadas.
Especificando sua API
Existem ferramentas no mercado (ex: APIMatic.io)
que auxiliam na geração de SDK’s e códigos de
exemplo nas principais linguagens do mercado.
SDK’s e Códigos de Exemplo
Mantenha sempre os desenvolvedores
informados das evoluções de suas API’s
(changelog) e ofereça uma forma de acompanhar
a disponibilidade dos serviços (ex: StatusPage.io).
Governança e disponibilidade
Desenhe sua API
pensando em consumo
público, mesmo que
seja interna ou para
parceiros.
https://swagger.io/resources/ebooks/api-documentation-the-secret-to-a-great-api-developer-experience/

13. 13
dev.elo.com.br
Vídeos explicativos facilitam o
entendimento tanto do ponto
de vista de negócio quanto
técnico.
Case 1:
Cartão Elo

14. 14
Case 2:
Pagar.me
docs.pagar.me
Métodos das APIs são simples
de entender e de consumir.

15. 15
Case 3:
Twilio
twilio.com/docs/usage/api
Exemplos de requisição nas
principais linguagens de
programação, bem como os
retornos esperados.

16. 03
16
Opte por plataformas como Slack, Rocket Chat
e Microsoft Teams para oferecer suporte às
suas API’s, bem como criar um canal de
comunicação rápido e eficiente entre o seu
time técnico e os desenvolvedores.
Suporte & Comunicação
Durante a escalada das API’s, poderá
ser necessário disponibilizar
atendimento de nível 1 e 2 para sanar
possíveis dúvidas e ajudar na
manutenção da documentação e na
certificação de parceiros.

17. 17
O que é DX?01.
Princípios02.
Criando03.
Consumo04.

18. 18
Os usuários e avaliadores das API’s devem entender
rapidamente o valor que elas oferecem, seus custos e
se existem restrições e/ou processo de avaliação.
Por que devo utilizar?
Esse processo deve ser o mais simples possível, e ao
mesmo tempo, suprir às necessidades mínimas para o
gerenciamento dos usuários.
Como me cadastrar?
Chegou a hora da experimentação. O segredo para
guiá-los nessa jornada? Um sandbox e uma ótima
documentação com exemplos.
Como utilizar?
Lembre-se que o desenvolvedor não estará no mesmo
contexto que você, portanto, detalhe o máximo
possível e ofereça um glossário para termos e/ou
abreviações utilizadas no seu segmento.
Faça para “humanos”
O ambiente de
experimentação é
fundamental para o
desenvolvedor avaliar
sua API.
https://swagger.io/resources/ebooks/api-documentation-the-secret-to-a-great-api-developer-experience/

19. 04
19
Hachathons podem acelerar o aprendizado na
jornada de consumo das API’s (cadastro,
documentação, exemplos e etc) dada a imersão
durante 24~48 horas seguidas entre os
participantes e o time responsável pelo
desenvolvimento.
Evoluindo DX através de
maratonas de programação

20. Obrigado!
20

21. 21
@i9dvdr@i9dvdr@i9dvdr @wupsbr
Vamos manter contato?
Aproveite e siga minhas redes sociais ;)