Documentação
Mostrar como começar a usar sua API
Mostrar exemplos de como implementar casos
de uso
Sandbox
Slide 21
Slide 21 text
Tratar Erros
Diferentes tipos de Exceções
Mensagens de Erro
“Errors should never pass silently. Unless
explicitly silenced”
Slide 22
Slide 22 text
Abordagem top-down
Primeiro pensar em como a API deve se
comportar
Prototipar
Iterar
Feedback
Slide 23
Slide 23 text
Prototypar e iterar
Slide 24
Slide 24 text
Design/Prototype
Implementation
Customer
Slide 25
Slide 25 text
Design/Prototype
Implementation
Customer :D
Slide 26
Slide 26 text
API Blueprint
apiblueprint.org
Ferramentas de mock
Suíte de testes
Slide 27
Slide 27 text
Empatia
Entender
Tente se por no lugar dos seus usuários
De todos os seus usuários
Slide 28
Slide 28 text
Funcionalidades são eternas
Eternas enquanto dure a versão da sua API
Não quebre clientes removendo
funcionalidades da sua API
Usuários só leem documentação uma vez
Slide 29
Slide 29 text
“APIs are starting to look more like the
product and less like the technology.”
Jason Harmon, Diretor de API Design @ PayPal