No Stress API

O que são APIs? Por que devemos usá-las, quais os benefícios e vantagens elas podem nos trazer? Esta palestra aborda fatos e dados que comprovam o benefício do uso de APIs para nosso negócio e como podemos desenvolve-las sem stress. Também serão apresentados cases, que permitiram economia de bilhões de dólares para empresas, por simplesmente, disponibilizarem suas informações.

Transcript

2. No Stress API
5. +800 dispositivos [*2008..2012] 6 Reasons why APIs are reshaping your business, faberNovel November 2012
6. 20_000 Devs [*2008..2012] 6 Reasons why APIs are reshaping your business, faberNovel November 2012
8. 20_000 * US$ 50_000 [*2008..2012] 6 Reasons why APIs are reshaping your business, faberNovel November 2012
9. US$ 1_000_000_000/Ano [*2008..2012] 6 Reasons why APIs are reshaping your business, faberNovel November 2012
10. NOVOS MODELOS DE NEGÓCIOS E FLUXOS DE RECEITA
11. DESENVOLVIMENTO DE PARCERIAS
12. "An application-programming interface (API) is a set of programming instructions and standards for accessing a Web-based software application." http://www.newpathweb.com.au/what-is-an-api-application-programming-interface
13. "An application-programming interface (API) is a set of programming instructions and standards for accessing a Web-based software application." http://www.newpathweb.com.au/what-is-an-api-application-programming-interface
14. REST Representational State Transfer
15. Arquitetura
16. "Roy Fielding é um cientista de computação norte- americano." http://pt.wikipedia.org/wiki/Roy_Fielding
17. "Roy Fielding é um cientista de computação norte- americano." Autor do protocolo HTTP Tese de Doutorado (phD) em 2000: REST Envolvido com o desenvolvimento do HTML e URI co-fundador do projeto Apache HTTP Server http://roy.gbiv.com/
18. A REST (Transferência do Estado Representativo) é pretendida como uma imagem do design da aplicação se comportará: uma rede de websites (um estado virtual), onde o utilizador progride com uma aplicação selecionando as ligações (transições do estado), tendo como resultado a página seguinte (que representa o estado seguinte da aplicação) que está sendo transferida ao utilizador e apresentada para seu uso. Definição
19. Resumo Comportamento & Transição de estados
21. VERBOS HTTP POST, GET, PUT, DELETE
22. GET
23. Coleção Retorna uma lista de ordem de serviços http://api.designasm.herokuapp.com/solicitacoes
25. Item específico Retorna a ordem de serviço com o ID 96453 http://api.designasm.herokuapp.com/solicitacoes/96453
27. POST
28. Coleção Cria um ou mais ordens de serviço http://api.designasm.herokuapp.com/solicitacoes
29. PUT
30. Item específico Atualiza a ordem de serviço com o ID 96453 http://api.designasm.herokuapp.com/solicitacoes/96453
31. DELETE
32. Coleção Deleta a coleção inteira http://api.designasm.herokuapp.com/solicitacoes
33. Item específico Deleta a ordem de serviço com o ID 96453 http://api.designasm.herokuapp.com/solicitacoes/96453
34. Mais uma coisa boa…
35. "FRONTENDERS" VÃO GOSTAR MAIS DE VOCÊS ;)
36. VOLTANDO EM APIS…
37. APIs != WebAPIs
40. APIS PERMITEM AS EMPRESAS A CONTROLAREM APENAS SUAS ATIVIDADES CHAVES
41. Macbook Air Arquitetura distribuída
42. Pense no design da API
43. ENDPOINTS SÃO AS ROTAS DA SUA API
44. PREFIRA SUBSTANTIVOS, A VERBOS
45. Verbos deixam sua API prolixa GET /listarPosts.json POST /criarPost.json GET /visualizarPost.json?id=1
46. Se aproveite dos Métodos HTTP GET /posts.json POST /posts.json GET /posts/1.json PUT /posts/1.json DELETE /posts/1.json
47. Sempre no plural, nunca singular Resources
48. Ruim GET /items GET /assets Substantivos concretos, nunca abstratos Bom GET /products GET /users
49. Relacione os resources de forma simples Photos has_many likes GET /photos/1/likes
50. Deixa complexidade para as query string
51. Filtros e Buscas GET /posts?status=draft GET /posts?q=something GET /posts/1/comments?user_id=1
52. NEGOCIAÇÃO DE CONTEÚDO QUAL A MELHOR FORMA DE APRESENTAR SEUS DADOS (quando se tem mais de uma possibilidade)
53. 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/
54. AUTENTICAÇÃO PREVENÇÃO DE ACESSO NÃO AUTORIZADO E RESOURCES PROTEGIDOS
56. Tokens
57. Como gerar um bom token?
58. SecureRandom.uuid
59. SecureRandom.uuid Universally Unique IDentifier
60. SecureRandom.uuid 123e4567-e89b-12d3-a456-426655440000
61. VERSIONAMENTO Como você vai incrementar sua API
62. MAJOR Mudanças que quebram a versão anterior MINOR Novas funcionalidades que não quebram a versão anterior PATCH Bugfixes Semantic Versioning
63. USE APENAS MAJOR VERSION
64. Como solicitar versões?
65. URL https://api.domain.com/v2/resources.json
66. DOMAIN https://api2.domain.com/resources.json
67. QUERY STRING https://api.domain.com/resources.json?version=2
68. HEADER api-version: 2
69. Version-less
71. TESTES Garanta que sua API seja consistente
72. Não é hora de testar a REGRA DO NEGÓCIO
73. STATUS CODE
75. MIME TYPES
77. REGRAS DE ACESSO
79. Dicas finais
80. Conheça seu público alvo
82. Utilize resultados paginados
83. GET /posts?page=2&perPage=1
84. Retorne erros com significado
86. Tenha uma boa documentação
87. Métodos, parâmetros, respostas e formatos
88. Você pode precisar dividir sua aplicação
89. SysAdmins agradecem!
90. Antes de terminar…
102. Por fim…
104. 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
105. Thanks! [github/fb/twitter]/jmscarpa joao.scarpa@gmail.com