Como testar e documentar REST APIs com ScanAPI - Agile Testers Conference 2021

https://www.atc.agiletesters.com.br/

Transcript

1. Como testar e documentar REST APIs com ScanAPI Agile Testers Conference - Nov 2021 Camila Maia
2. Esta apresentação está disponível em: speakerdeck.com/cmaiacd
3. Quem sou eu? - Desenvolvedora Backend - 10+ anos xp 👵 - Python 🐍 e Ruby 💎 - OpenSource e Comunidades ❤ - Organização de eventos: Pyjamas, EuroPython, Python Brasil….
4. - Primeiro perfil aprovado no programa de Sponsors para quem reside no Brasil 󰎙 Quem sou eu?
5. Motivação Tudo começou numa bela semana de firefighter… 🔥
6. Motivação Erros de integração 💥 - Clientes enviando campos diferentes do esperado - Frontend recebendo campos diferentes do esperado
7. - Endpoints e campos faltantes - Desinformação Motivação Documentação desatualizada 📜
8. /reservar/:id_do_assento id_do_voo? id_da_aeronave? id_do_passageiro? Aeronave está disponível? ???? Motivação Dificuldade em recriar o cenário 😤
9. Motivação Dificuldade em recriar o cenário 😤
12. • Framework de código aberto • Command line interface (CLI) • Escrito em Python Objetivos: 1. Fornecer Live Documentation 2. Possibilitar a implementação de Testes de Integração O quê é?
13. PokéAPI: https://pokeapi.co $ http https://pokeapi.co/api/v2/pokemon/ Como funciona? Exemplo: PokéAPI
16. Como funciona? • Python • $ pip install scanapi Exemplo: PokéAPI
17. # scanapi.yaml endpoints: - name: pokeapi path: https://pokeapi.co/api/v2/ endpoints: - name: pokemon path: pokemon requests: - name: list_all method: get path: / Como funciona? Exemplo: PokéAPI path: https://pokeapi.co/api/v2/ pokemon / name: pokeapi :: pokemon :: list_all
18. Como funciona? Executar... Exemplo: PokéAPI
19. Documentação 📄
20. Documentação 📄
21. Documentação 📄
22. Documentação 📄
23. ... 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_1118 assert: ${{ response.json()["count"] >= 1118 }} Como funciona? https://requests.readthedocs.io Testes de Integração ✅
24. Testes de Integração ✅
25. Testes de Integração ✅
26. Como funciona? - Pegar detalhes de um Pokémon - Neste caso o dado é “estático”, mas poderia não ser https://pokeapi.co/api/v2/pokemon/bulbasaur Encadeamento ⛓
27. Como funciona? ... 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}
28. Encadeamento ⛓
29. Como funciona? E tem mais 🎉 - Independente de linguagem! - Especificação da API também é aceita em JSON - Variável de Ambiente - Esconder dados sensitivos no relatório - Especificação da API em vários arquivos - Delay entre requests - Templates Customizados - VS Code Plugin
30. Adicionando ScanAPI ao seu projeto
31. Adicionando ScanAPI ao seu projeto Exemplo: CircleCI
32. Adicionando ScanAPI ao seu projeto Exemplo: CircleCI
33. # my_project/.circleci/config.yml ... scanapi: docker: - image: camilamaia/scanapi:2.1.0 steps: - checkout - run: name: Run ScanAPI command: | scanapi run scanapi/scanapi.yaml -c scanapi/scanapi.conf -o scanapi/report.html - store_artifacts: path: scanapi/report.html workflows: version: 2 main: jobs: - scanapi: filters: branches: only: - master - build-push: name: build-push-staging env: staging requires: - scanapi filters: branches: only: - master
34. Adicionando ScanAPI ao seu projeto Examplo: GitHub Action
35. # my_project/.github/workflows/scanapi.yml on: push: branches: [master] name: Run ScanAPI jobs: scanapi: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Run automated API tests uses: scanapi/github-action@v1 with: scanapi_version: "==2.1.0" arguments: "run ./pokeapi/scanapi.yaml" - name: Upload scanapi-report.html uses: actions/upload-artifact@v2 with: name: ScanAPI Report path: scanapi-report.html
36. scanapi.dev 🌐
37. scanapi/examples
38. Próximos passos E o futuro? 🔮 • Foco: aumentar a adoção da ferramenta. Divulgação! Falando em novas features, e se…. • Exportar: OpenAPI, Postman Collection, Insomnia… Esforço quase nulo para adoção!
39. Por que utilizar ScanAPI? 8 motivos! 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 8. Não há nada no mercado que faça o que o ScanAPI faz
40. GitHub - https://github.com/scanapi Twitter - @ScanAPI_ Discord - discord.scanapi.dev Comunicação Bora trocar uma ideia! 🗣
41. github.com/scanapi ⭐
42. Bora usar!
43. E compartilhar! 🚀
44. MUITO OBRIGADA! @cmaiacd camilamaia 󰠁 cmaiacd.com