Upgrade to Pro — share decks privately, control downloads, hide ads and more …

APIs do Jeito Certo

Er Galvão Abbott
December 13, 2024
0
170

APIs do Jeito Certo

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

Er Galvão Abbott

December 13, 2024
Tweet

More Decks by Er Galvão Abbott

See All by Er Galvão Abbott
O que eu aprendi em 30 anos de TI
galvao
1
39
Workshop Git
galvao
0
43
Git Branching: Equívocos, Erros e Soluções
galvao
2
120
g-flow: Uma implementação Gitflow Completa e Prática
galvao
1
150
The road to Node... (and other things)
galvao
0
88
APIs com PHP: da Criação ao Consumo
galvao
0
130
PHP ❤️ Software Livre
galvao
0
130
Desenvolvimento de APIs
galvao
0
68
Laminas - O que é, o que representa e como usar
galvao
0
89

Featured

See All Featured
VelocityConf: Rendering Performance Case Studies
addyosmani
326
24k
Why Our Code Smells
bkeepers
PRO
335
57k
It's Worth the Effort
3n
183
28k
The Cost Of JavaScript in 2023
addyosmani
45
7k
Building a Modern Day 
E-commerce SEO Strategy
aleyda
38
7k
Typedesign – Prime Four
hannesfritz
40
2.4k
Building a Scalable Design System with Sketch
lauravandoore
460
33k
Mobile First: as difficult as doing things right
swwweet
222
9k
The Power of CSS Pseudo Elements
geoffreycrofte
73
5.4k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
356
29k
Music & Morning Musume
bryan
46
6.2k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
32
2.7k

Transcript

  1. CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott -

    12/13/24 - 1 / 81 galvao.eti.br v 1.2.0 - 2024-12-07 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/13/2024 – v0.2.0 – Slide 2 / 81

  3. galvao.eti.br Objetivo CC Attribution-ShareAlike 3.0 Unported License by Er Galvão

    Abbott - 12/13/24 - 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/13/24 - 4 / 81

  5. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er

    Galvão Abbott - 12/13/24 - 5 / 81 APIs?

  6. APIs FTW! galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er

    Galvão Abbott - 12/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 22 / 81

  23. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 23 / 81 Por que Design-First?

  24. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 24 / 81 Por que Design-First?

  25. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 25 / 81 x Por que Design-First?

  26. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 26 / 81 x Por que Design-First?

  27. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 27 / 81 x Por que Design-First?

  28. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 28 / 81 x Por que Design-First?

  29. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 29 / 81 x Por que Design-First?

  30. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 30 / 81 x Por que Design-First?

  31. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 35 / 81 Por que Design-First?

  36. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 39 / 81 Por que ReST?

  40. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 40 / 81 + Client-Server Por que ReST?

  41. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 69 / 81 FERRAMENTAS! FERRAMENTAS!

  70. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 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/13/24 - 75 / 81 TESTING httpie.io http-prompt - github.com/httpie/http-prompt Postman - postman.com usebruno.com terminaltrove.com/atac

  76. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 76 / 81 http-prompt x

  77. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 77 / 81 + http-prompt

  78. galvao.eti.br CC Attribution-ShareAlike 3.0 Unported License by Er Galvão Abbott

    - 12/13/24 - 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/13/24 - 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/13/24 - 80 / 81 Concluindo...

  81. galvao.eti.br Muito Obrigado! CC Attribution-ShareAlike 3.0 Unported License by Er

    Galvão Abbott - 12/13/24 - 81 / 81 Dúvidas, Críticas, Elogios, etc…? ‘bora conversar!