APIs do jeito certo

Um apanhado geral sobre APIs, incluindo Design-first, OAS, Restful e instrumental.

Transcript

1. CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 1 / 81 galvao.eti.br v 1.1.0 - 2023-12-09 APIs do jeito certo
2. Atua há 30 anos no Mercado de TI: Programador (> 25), Professor / Palestrante (> 20) e Consultor (> 25) Engenheiro de Software Sênior / Tech Lead Professor Convidado (Especialista) de Pós-Graduação (PR e SC) Diretor, ConFLOSS, NodeConBR e PHP Conference Brasil Evangelista e Contribuidor para a Linguagem PHP Evangelista e Contribuidor para o Laminas Project Primeiro Brasileiro a se tornar Postman Supernova Presidente da ABRAPHP – Associação Brasileira de Profissionais PHP Apaixonado por Backend, APIs, Qualidade, Segurança e Software Livre galvao.eti.br galvao.eti.br Meu nome é Galvão CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/09/2023 – v0.2.0 – Slide 2 / 81
3. galvao.eti.br Objetivo CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 3 / 81 Apresentar um apanhado geral sobre APIs, incluindo: • Design-First • OpenAPI Specification • Ciclo de desenvolvimento • ReST(ful) • e instrumental.
4. APIs...? galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 4 / 81
5. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 5 / 81 APIs?
6. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 6 / 81 APIs? strlen( string $str ) → int
7. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 7 / 81 APIs? strlen( string $str ) → int ponto de acesso
8. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 8 / 81 APIs? strlen( string $str ) → int ponto de acesso informação
9. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 9 / 81 APIs? strlen( string $str ) → int ponto de acesso informação resultado
10. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 10 / 81 APIs? strlen( string $str ) → int https://whatevers/product/1109 → {...}
11. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 11 / 81 APIs? strlen( string $str ) → int https://whatevers/product/1109 → {...} ponto de acesso
12. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 12 / 81 APIs? strlen( string $str ) → int https://whatevers/product/1109 → {...} ponto de acesso informação
13. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 13 / 81 APIs? strlen( string $str ) → int https://whatevers/product/1109 → {...} ponto de acesso informação resultado
14. Por que toda a aplicação deveria ser desenvolvida como uma API? galvao.eti.br Por que APIs CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 14 / 81
15. Por que toda a aplicação deveria ser desenvolvida como uma API? galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 15 / 81 Por que APIs
16. Por que toda a aplicação deveria ser desenvolvida como uma API? galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 16 / 81 Por que APIs + Verdadeira Separação entre Back e Front
17. Por que toda a aplicação deveria ser desenvolvida como uma API? galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 17 / 81 Por que APIs + Verdadeira Separação entre Back e Front + Agnosticismo de linguagens
18. Por que toda a aplicação deveria ser desenvolvida como uma API? galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 18 / 81 Por que APIs + Verdadeira Separação entre Back e Front + Agnosticismo de linguagens + Otimização de Performance de backend
19. Por que toda a aplicação deveria ser desenvolvida como uma API? galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 19 / 81 Por que APIs + Verdadeira Separação entre Back e Front + Agnosticismo de linguagens + Otimização de Performance de backend + Um back*, múltiplos fronts
20. Por que toda a aplicação deveria ser desenvolvida como uma API? galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 20 / 81 Por que APIs + Verdadeira Separação entre Back e Front + Agnosticismo de linguagens + Otimização de Performance de backend + Um back*, múltiplos fronts + Escalabilidade*
21. Por que toda a aplicação deveria ser desenvolvida como uma API? galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 21 / 81 Por que APIs + Verdadeira Separação entre Back e Front + Agnosticismo de linguagens + Otimização de Performance de backend + Um back*, múltiplos fronts + Escalabilidade* * Ou, até mesmo, múltiplos backs e fronts
22. Por que Design-First? galvao.eti.br Por que Design-First? CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 22 / 81
23. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 23 / 81 Por que Design-First?
24. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 24 / 81 Por que Design-First?
25. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 25 / 81 x Por que Design-First?
26. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 26 / 81 x Por que Design-First?
27. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 27 / 81 x Por que Design-First?
28. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 28 / 81 x Por que Design-First?
29. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 29 / 81 x Por que Design-First?
30. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 30 / 81 x Por que Design-First?
31. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 31 / 81 Por que Design-First? openapis.org
32. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 32 / 81 Por que Design-First? ... paths openapis.org
33. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 33 / 81 Por que Design-First? ... paths + components openapis.org
34. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 34 / 81 Por que Design-First? ... paths + components + $ref ... openapis.org
35. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 35 / 81 Por que Design-First?
36. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 36 / 81 Por que Design-First? Zero Code
37. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 37 / 81 Por que Design-First? Zero Code Code
38. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 38 / 81 Por que ReST? Por que ReST?
39. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 39 / 81 Por que ReST?
40. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 40 / 81 + Client-Server Por que ReST?
41. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 41 / 81 + Client-Server + Stateless - não existe persistência de estado Por que ReST?
42. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 42 / 81 + Client-Server + Stateless - não existe persistência de estado + Cache - Declaração explícita se a resposta é cacheável Por que ReST?
43. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 43 / 81 + Client-Server + Stateless - não existe persistência de estado + Cache - Declaração explícita se a resposta é cacheável + Uniformidade de Interface Por que ReST?
44. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 44 / 81 + Client-Server + Stateless - não existe persistência de estado + Cache - Declaração explícita se a resposta é cacheável + Uniformidade de Interface + Camadas - Impossibilidade de determinar “tipo” de conexão Por que ReST?
45. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 45 / 81 … e, além disso... … e, além disso...
46. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 46 / 81 … e, além disso... SQL HTTP(S) C R U D
47. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 47 / 81 … e, além disso... SQL HTTP(S) Create Retrieve Update Delete
48. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 48 / 81 … e, além disso... INSERT SQL HTTP(S) Create Retrieve Update Delete
49. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 49 / 81 … e, além disso... INSERT SQL HTTP(S) Create Retrieve Update Delete POST
50. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 50 / 81 … e, além disso... INSERT SELECT SQL HTTP(S) Create Retrieve Update Delete POST
51. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 51 / 81 … e, além disso... INSERT SELECT SQL HTTP(S) Create Retrieve Update Delete POST GET
52. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 52 / 81 … e, além disso... INSERT SELECT UPDATE SQL HTTP(S) Create Retrieve Update Delete POST GET
53. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 53 / 81 … e, além disso... INSERT SELECT UPDATE SQL HTTP(S) Create Retrieve Update Delete POST GET PATCH / PUT
54. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 54 / 81 … e, além disso... INSERT SELECT UPDATE DELETE SQL HTTP(S) Create Retrieve Update Delete POST GET PATCH / PUT
55. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 55 / 81 … e, além disso... INSERT SELECT UPDATE DELETE SQL HTTP(S) Create Retrieve Update Delete POST GET PATCH / PUT DELETE
56. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 56 / 81 httpstatuses.com … e, além disso... ‘bora falar de status HTTP?
57. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 57 / 81 httpstatuses.com … e, além disso... Sim, precisamos falar de status HTTP...
58. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 58 / 81 httpstatuses.com Mais … e, além disso...
59. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 59 / 81 httpstatuses.com Mais 201, 204, 401, 403, 404, 405, 406, 413, 429... … e, além disso...
60. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 60 / 81 httpstatuses.com Mais 201, 204, 401, 403, 404, 405, 406, 413, 429... Menos … e, além disso...
61. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 61 / 81 httpstatuses.com Mais 201, 204, 401, 403, 404, 405, 406, 413, 429... Menos 200, 400. … e, além disso...
62. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 62 / 81 httpstatuses.com Mais 201, 204, 401, 403, 404, 405, 406, 413, 429... Menos 200, 400. Nunca* … e, além disso...
63. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 63 / 81 httpstatuses.com Mais 201, 204, 401, 403, 404, 405, 406, 413, 429... Menos 200, 400. Nunca* 5xx. … e, além disso...
64. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 64 / 81 Create Retrieve Update Delete INSERT SELECT UPDATE DELETE POST GET PATCH / PUT DELETE SQL HTTP(S) Response … e, além disso...
65. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 65 / 81 Create Retrieve Update Delete INSERT SELECT UPDATE DELETE POST GET PATCH / PUT DELETE SQL HTTP(S) Response 201 … e, além disso...
66. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 66 / 81 Create Retrieve Update Delete INSERT SELECT UPDATE DELETE POST GET PATCH / PUT DELETE SQL HTTP(S) Response 201 200 … e, além disso...
67. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 67 / 81 Create Retrieve Update Delete INSERT SELECT UPDATE DELETE POST GET PATCH / PUT DELETE SQL HTTP(S) Response 201 200 204 … e, além disso...
68. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 68 / 81 Create Retrieve Update Delete INSERT SELECT UPDATE DELETE POST GET PATCH / PUT DELETE SQL HTTP(S) Response 201 200 204 204 … e, além disso...
69. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 69 / 81 FERRAMENTAS! FERRAMENTAS!
70. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 70 / 81 • Documentation • Linting • Mocking • Proxying • Testing FERRAMENTAS!
71. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 71 / 81 LINTING spectral - stoplight.io/open-source/spectral Postman - postman.com
72. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 72 / 81 MOCKING prism - stoplight.io/open-source/prism Postman - postman.com
73. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 73 / 81 DOCUMENTATION elements - stoplight.io/open-source/elements redoc-cli - yarnpkg.com/package/redoc-cli Postman - postman.com
74. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 74 / 81 PROXYING prism - stoplight.io/open-source/prism Postman - postman.com
75. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 75 / 81 TESTING httpie.io http-prompt - github.com/httpie/http-prompt Postman - postman.com
76. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 76 / 81 http-prompt x
77. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 77 / 81 http-prompt +
78. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 78 / 81 http-prompt Performance Testes Rápidos Pipeline
79. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 79 / 81 “Tudo-em-um” Gerência de grandes APIs Replayability Features que são melhores em aplicações GUI E mais...
80. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 80 / 81 Concluindo...
81. galvao.eti.br Muito Obrigado! CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott - 12/9/23 - 81 / 81 Dúvidas, Críticas, Elogios, etc…? ‘bora conversar!