Como testar e manter APIs de qualidade - Codecon Digital 2023

Transcript

1. Codecon Digital 2023 Camila Maia Como testar e manter APIs de qualidade
2. Esta apresentação está disponível em: speakerdeck.com/camilamaia
3. Quem sou eu?
4. 👩
5. Senior Backend Developer
6. Moro em Berlim 󰎲
7. Queer 󰝲
8. Python 🐍 Ruby 💎
9. Comunidade ❤
10. Open Source ❤
12. Por que testar APIs?
13. Verificação da funcionalidade
14. Integridade dos dados 🎲
15. Confiabilidade ☑
16. Velocidade no processo de desenvolvimento
17. Facilita a Manutenção 🧰
18. Como testar?
19. Testes Unitários Dependente de Linguagem
20. Testes de Segurança 🔐
21. Testes de Desempenho e Escalabilidade
22. Testes de Integração Testam os contratos. Independente de linguagem.
24. Framework de Testes
25. Código Aberto 📖
26. Command Line Interface - CLI
27. Python 🐍
28. Objetivos
29. Fornecer Live Documentation 📃
30. Possibilitar a implementação de Testes de Integração
31. Exemplo
32. PokéAPI: https://pokeapi.co $ http https://pokeapi.co/api/v2/pokemon/ PokéAPI
35. Instalação
36. Python $ pip install scanapi
37. Como usar?
38. # scanapi.yaml endpoints: - name: pokeapi path: https://pokeapi.co/api/v2/ endpoints: - name: pokemon path: pokemon requests: - name: list_all method: get path: / path: https://pokeapi.co/api/v2/ pokemon / name: pokeapi :: pokemon :: list_all
39. $ scanapi run
40. Documentação 📄
41. Documentação 📄
42. Documentação 📄
43. Documentação 📄
44. Testes de Integração ✅
45. ... requests: - name: list_all method: get path: / tests: - name: status_code_is_200 assert: ${{ response.status_code == 200 }} - name: response_time_is_under_half_second assert: ${{ response.elapsed.total_seconds() < 0.5 }} - name: results_length_is_20 assert: ${{ len(response.json()["results"]) == 20 }} - name: count_is_gte_1281 assert: ${{ response.json()["count"] >= 1281 }} https://requests.readthedocs.io
46. Testes de Integração ✅
47. Testes de Integração ✅
48. Testes de Integração ✅
49. Encadeamento ⛓
50. Acessar detalhes de um Pokémon dinamicamente GET https://pokeapi.co/api/v2/pokemon/bulbasaur
51. ... endpoints: - name: pokemon path: pokemon requests: - name: list_all method: get path: / vars: pokemon_name: ${{ response.json()["results"][0]["name"] }} tests: ... - name: details method: get path: ${pokemon_name} pokemon/${pokemon_name}
52. Encadeamento ⛓
53. scanapi.dev 🌐
55. Docs
56. Tutorial
57. Exemplos
58. Ou…
59. Por que utilizar ScanAPI?
60. 1. Funciona para qualquer API REST 2. Excelente para testar e documentar APIs próprias e de terceiros 3. É possível encadear requests, o que é essencial para testar cenários complexos 4. A documentação é gerada automaticamente, ela nunca fica desatualizada 5. É simples. A sintaxe é simples e não requer quase nenhum conhecimento específico da linguagem 6. É extremamente flexível 7. É seguro
61. +1.5k/mês ⬇ + 1.2k ⭐
62. GitHub - https://github.com/scanapi Twitter - @ScanAPI_ Discord - discord.scanapi.dev
63. github.com/scanapi/scanapi
64. MUITO OBRIGADA! @cmaiacd camilamaia 󰠁 camilamaia.com