Slide 1
Slide 1 text
Codecon Digital 2023
Camila Maia
Como testar e manter APIs
de qualidade
Slide 2
Slide 2 text
Esta apresentação está disponível em:
speakerdeck.com/camilamaia
Slide 3
Slide 3 text
Quem sou eu?
Slide 4
Slide 4 text
👩
Slide 5
Slide 5 text
Senior Backend Developer
Slide 6
Slide 6 text
Moro em Berlim
Slide 7
Slide 7 text
Queer
Slide 8
Slide 8 text
Python 🐍 Ruby 💎
Slide 9
Slide 9 text
Comunidade ❤
Slide 10
Slide 10 text
Open Source ❤
Slide 11
Slide 11 text
No content
Slide 12
Slide 12 text
Por que testar APIs?
Slide 13
Slide 13 text
Verificação da funcionalidade
Slide 14
Slide 14 text
Integridade dos dados 🎲
Slide 15
Slide 15 text
Confiabilidade ☑
Slide 16
Slide 16 text
Velocidade no processo de
desenvolvimento
Slide 17
Slide 17 text
Facilita a Manutenção 🧰
Slide 18
Slide 18 text
Como testar?
Slide 19
Slide 19 text
Testes Unitários
Dependente de Linguagem
Slide 20
Slide 20 text
Testes de Segurança 🔐
Slide 21
Slide 21 text
Testes de Desempenho e
Escalabilidade
Slide 22
Slide 22 text
Testes de Integração
Testam os contratos. Independente de linguagem.
Slide 23
Slide 23 text
No content
Slide 24
Slide 24 text
Framework de Testes
Slide 25
Slide 25 text
Código Aberto 📖
Slide 26
Slide 26 text
Command Line Interface - CLI
Slide 27
Slide 27 text
Python 🐍
Slide 28
Slide 28 text
Objetivos
Slide 29
Slide 29 text
Fornecer Live Documentation 📃
Slide 30
Slide 30 text
Possibilitar a implementação de
Testes de Integração
Slide 31
Slide 31 text
Exemplo
Slide 32
Slide 32 text
PokéAPI: https://pokeapi.co
$ http https://pokeapi.co/api/v2/pokemon/
PokéAPI
Slide 33
Slide 33 text
No content
Slide 34
Slide 34 text
No content
Slide 35
Slide 35 text
Instalação
Slide 36
Slide 36 text
Python
$ pip install scanapi
Slide 37
Slide 37 text
Como usar?
Slide 38
Slide 38 text
# 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
Slide 39
Slide 39 text
$ scanapi run
Slide 40
Slide 40 text
Documentação 📄
Slide 41
Slide 41 text
Documentação 📄
Slide 42
Slide 42 text
Documentação 📄
Slide 43
Slide 43 text
Documentação 📄
Slide 44
Slide 44 text
Testes de Integração ✅
Slide 45
Slide 45 text
...
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
Slide 46
Slide 46 text
Testes de Integração ✅
Slide 47
Slide 47 text
Testes de Integração ✅
Slide 48
Slide 48 text
Testes de Integração ✅
Slide 49
Slide 49 text
Encadeamento ⛓
Slide 50
Slide 50 text
Acessar detalhes de um Pokémon dinamicamente
GET https://pokeapi.co/api/v2/pokemon/bulbasaur
Slide 51
Slide 51 text
...
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}
Slide 52
Slide 52 text
Encadeamento ⛓
Slide 53
Slide 53 text
scanapi.dev 🌐
Slide 54
Slide 54 text
No content
Slide 55
Slide 55 text
Docs
Slide 56
Slide 56 text
Tutorial
Slide 57
Slide 57 text
Exemplos
Slide 58
Slide 58 text
Ou…
Slide 59
Slide 59 text
Por que utilizar ScanAPI?
Slide 60
Slide 60 text
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
Slide 61
Slide 61 text
+1.5k/mês ⬇
+ 1.2k ⭐
Slide 62
Slide 62 text
GitHub
- https://github.com/scanapi
Twitter
- @ScanAPI_
Discord
- discord.scanapi.dev
Slide 63
Slide 63 text
github.com/scanapi/scanapi
Slide 64
Slide 64 text
MUITO OBRIGADA!
@cmaiacd camilamaia
camilamaia.com