No Stress API - Rupy Brazil 2014

Transcript

1. rupy 2014 29 NOV - SÃO JOSÉ DOS CAMPOS
2. No Stress API
5. +800 dispositivos [*2008..2012]
6. 20_000 Devs [*2008..2012]
8. 20_000 * US$ 50_000 [*2008..2012]
9. US$ 1_000_000_000/Ano [*2008..2012]
10. NOVOS MODELOS DE NEGÓCIOS E FLUXOS DE RECEITA
11. DESENVOLVIMENTO DE PARCERIAS
12. MAS NÃO SE PREOCUPEM, NÃO VAMOS FALAR DE NEGÓCIOS
13. João Mateus Scarpa
14. RUBY DEVELOPER API FANATIC JAPANESE FOOD <3
15. Disclaimer
16. Nós não vamos falar de rails vs grape vs rails-api
18. "An application-programming interface (API) is a set of programming instructions and standards for accessing a Web-based software application."
19. "An application-programming interface (API) is a set of programming instructions and standards for accessing a Web-based software application."
20. VERBOS HTTP POST, GET, PUT, DELETE
21. REST Representational State Transfer
22. FRONTENDERS VÃO GOSTAR MAIS DE VOCÊ ;)
24. APIS PERMITEM AS EMPRESAS A CONTROLAREM APENAS SUAS ATIVIDADES CHAVES
25. ENDPOINTS SÃO AS ROTAS DA SUA API
26. PREFIRA SUBSTANTIVOS, A VERBOS
27. Verbos deixam sua API prolixa GET /listarPosts.json POST /criarPost.json GET /visualizarPost.json?id=1
28. Se aproveite dos Métodos HTTP GET /posts.json POST /posts.json GET /posts/1.json PUT /posts/1.json DELETE /posts/1.json
29. Sempre no plural, nunca singular Resources
30. Ruim GET /items GET /assets Substantivos concretos, nunca abstratos Bom GET /products GET /users
31. Relacione os resources de forma simples Photos has_many likes GET /photos/1/likes
32. Deixa complexidade para as query string
33. Filtros e Buscas GET /posts?status=draft GET /posts?q=something GET /posts/1/comments?user_id=1
34. NEGOCIAÇÃO DE CONTEÚDO QUAL A MELHOR FORMA DE APRESENTAR SEUS DADOS (quando se tem mais de uma possibilidade)
35. making it possible to have different versions of the same response, and letting clients specify which version they want to receive. http://apiux.com/2013/05/07/api-content-negotiation/
40. ActiveModelSerializer
41. ActiveModelSerializer JBuilder
42. ActiveModelSerializer JBuilder Roar
43. ActiveModelSerializer JBuilder Roar Rabl
45. AUTENTICAÇÃO PREVENÇÃO DE ACESSO NÃO AUTORIZADO E RESOURCES PROTEGIDOS
48. Tokens
50. Como gerar um bom token?
51. SecureRandom.uuid
52. SecureRandom.uuid Universally Unique IDentifier
53. SecureRandom.uuid 123e4567-e89b-12d3-a456-426655440000
54. VERSIONAMENTO Como você vai incrementar sua API
55. MAJOR Mudanças que quebram a versão anterior MINOR Novas funcionalidades que não quebram a versão anterior PATCH Bugfixes Semantic Versioning
56. USE APENAS MAJOR VERSION
57. Como solicitar versões?
58. URL https://api.domain.com/v2/resources.json
59. DOMAIN https://api2.domain.com/resources.json
60. QUERY STRING https://api.domain.com/resources.json?version=2
61. HEADER api-version: 2
62. Version-less
64. TESTES Garanta que sua API seja consistente
65. Não é hora de testar a REGRA DO NEGÓCIO
66. STATUS CODE
68. MIME TYPES
70. REGRAS DE ACESSO
72. Dicas finais
73. Conheça seu público alvo
75. Utilize resultados paginados
76. GET /posts?page=2&perPage=1
77. Retorne erros com significado
79. Tenha uma boa documentação
80. Métodos, parâmetros, respostas e formatos
81. Você pode precisar dividir sua aplicação
82. SysAdmins agradecem!
83. Por fim…
85. 6 Reasons Why APIs Are Reshaping Your Business, http://pt.slideshare.net/faberNovel/6-reasons-why-apis-are-reshaping-your-business Novembro 2012 References Programmable Web, http://www.programmableweb.com/ Outubro 2014 How to Design a Good API and Why it Matters, http://lcsd05.cs.tamu.edu/slides/keynote.pdf Outubro 2014 Implementing API Content Negotiation, http://apiux.com/2013/05/07/api-content-negotiation/ Maio 2013 5 reason why developer are not using your API, http://nordicapis.com/5-reasons-why-developers-are-not-using-your-api/ Outubro 2014
86. Thanks! [github/fb/twitter]/jmscarpa joao.scarpa@gmail.com