API Connect Testador

A ferramenta API Connect Tester testa APIs, gera casos de teste, conjuntos de teste e muito mais.

A ferramenta conclui as operações compatíveis com a ferramenta API Test and Monitor (ATM). Ele testa as APIs para garantir que elas estejam funcionando conforme o esperado. Ele se concentra na verificação de que os pontos de extremidade da API exibem as respostas corretas para várias entradas e cenários, criando asserções de teste.

Detalhes da ferramenta
  • O teste de API pode ser acessado na guia Testes de API no API Manager.
  • Essa ferramenta usa o recurso Smart Generation para gerar casos de teste.
As seguintes operações são compatíveis com a ferramenta API Connect Tester:

Gerar casos de teste

A operação Generate test case cria um conjunto de testes a partir da API fornecida ou do arquivo de especificação OpenAPI. A API pode ser um rascunho ou publicada em um catálogo específico. Cada caso de teste no conjunto corresponde a um endpoint diferente. Se existir um conjunto de testes para o arquivo de especificação OpenAPI ou API fornecido, ele será excluído e um novo será criado. Você pode controlar o número de casos de teste que são listados usando os parâmetros de limite e deslocamento.

Essa operação exibe uma lista de casos de teste como links, direcionando-o para os casos de teste correspondentes no API Manager.
Nota:
  • Se o nome do catálogo não for especificado, o conjunto de testes será criado para um rascunho de API com o nome fornecido (se disponível). Para gerar casos de teste em uma API publicada, especifique o nome do catálogo.
  • Se a especificação OpenAPI de uma API for atualizada depois que um conjunto de testes tiver sido criado, o conjunto de testes existente deverá ser excluído. Um novo conjunto de testes deve ser criado com base na especificação atualizada da API.
Tabela 1. Parâmetros
Parâmetro Descrição Valor Padrão Necessário
api_name O nome da API para a qual os casos de teste devem ser criados. Nenhum Opcional
api_file O nome da especificação da API aberta para a qual o caso de teste deve ser executado. Nenhum Opcional
catalog O nome do catálogo no qual o usuário publicou a API. Nenhum Opcional
version A versão específica da API que foi publicada ou a versão especificada na API. Nenhum Opcional
limit Número máximo de casos de teste, que está na resposta. Recebe um valor inteiro. 15 Opcional
Offset Ignora esse número de casos de teste e recupera os casos de teste restantes. Recebe um valor inteiro. 0 Opcional
Exemplos de prompts
  • Generate test case for Swagger-Petstore api
  • Generate test case for Swagger-Petstore api in sandbox
  • Generate test for Swagger-Petstore:1.0.0 api
  • Generate test for Swagger-Petstore api with version 1.0.0 in sandbox
  • Generate test case for Swagger-Petstore api with limit 5 offset 15
  • Generate test case for @bookshop.yaml
Próxima ação sugerida
Run test case for the test suite {testsuite_name}

Executar casos de teste

O caso de teste run executa os casos de teste no conjunto de testes fornecido ou criado para uma API. Durante a execução, são feitas chamadas à API e as afirmações são validadas. A API pode ser um rascunho ou publicada em um catálogo específico. Você pode controlar o número de casos de teste que são listados usando os parâmetros de limite e deslocamento. Essa operação só pode ser executada após a operação Gerar caso de teste.

Durante essa operação, cada caso de teste é verificado quanto a um servidor válido URL para fazer chamadas de API. Se o servidor URL estiver ausente, como nos rascunhos de APIs, o caso de teste não será executado. O usuário é solicitado a atualizar o servidor URL no editor por meio de um link clicável para o caso de teste. Se o caso de teste tiver um servidor válido URL, um link o direcionará para a guia Report (Relatório ) dos casos de teste no API Manager, onde você poderá analisar os resultados do teste.
Tabela 2. Parâmetros
Parâmetro Descrição Valor Padrão
api_name Nome da API para a qual os casos de teste devem ser executados. Nenhum
api_file O nome da especificação da API aberta para a qual o caso de teste deve ser executado. Nenhum
test_name Nome do caso de teste que deve ser executado. Nenhum
testsuite_name Nome do conjunto de testes para o qual os casos de teste devem ser executados. Nenhum
catalog O nome do catálogo que o usuário publicou na API. Nenhum
version A versão específica da API que foi publicada ou a versão especificada na API. Nenhum
limit Número máximo de casos de teste, que é mostrado na resposta. Recebe um valor inteiro. 15
Offset Ignora esse número de casos de teste e recupera os casos de teste restantes. Recebe um valor inteiro. 0
Exemplos de prompts
  • run test for AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • run test for Swagger-Petstore api
  • run test for Swagger-Petstore api in sandbox
  • run test for Swagger-Petstore:1.0.0 api
  • run test for Swagger-Petstore api with version 1.0.0 in sandbox
  • run test for AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • run test for AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger-Petstore-1.0.0 test suite
  • run test for Swagger-Petstore api with limit 5 offset 15
Próxima ação sugerida
Get test status for the {api_name} api
Get test status for the test suite {testsuite_name}

Testar API

A operação Test API gera casos de teste e os executa para a API fornecida ou para o arquivo de especificação OpenAPI. A API pode ser um rascunho ou ser publicada em um catálogo específico. Você pode controlar o número de casos de teste que são listados usando os parâmetros de limite e deslocamento.

A operação apresenta esses casos de teste como links clicáveis, direcionando-o para a guia Relatório dos casos de teste no API Manager, onde é possível revisar os resultados do teste.

Tabela 3. Parâmetros
Parâmetro Descrição Valor Padrão
api_name Nome da API para a qual os casos de teste devem ser criados e executados. Nenhum
api_file Nome da especificação da API aberta para a qual o caso de teste deve ser criado e executado. Nenhum
catalog O nome do catálogo no qual o usuário publicou a API. Nenhum
version A versão específica da API que foi publicada ou a versão especificada na API. Nenhum
limit Número máximo de casos de teste que serão exibidos na resposta. Recebe um valor inteiro. 15
offset Ignora esse número de casos de teste e recupera os casos de teste restantes. Recebe um valor inteiro. 0
Exemplos de prompts
  • test api Swagger-Petstore api
  • test api Swagger-Petstore api in sandbox
  • test api Swagger-Petstore:1.0.0 api
  • test api Swagger-Petstore api with version 1.0.0 in sandbox
  • test api for Swagger-Petstore api with limit 5 offset 15
  • test api for @bookshop.yaml
Próxima ação sugerida
Get test status for the {api_name} api
 Get test status for the test suite {testsuite_name}

Listar suítes de teste

A operação listar conjunto de testes fornece uma lista de todos os conjuntos de testes presentes na organização do provedor.

Exemplo de prompt:
list test suites

Listar casos de teste

A operação listar casos de teste exibe a lista de casos de teste presentes para o conjunto de testes ou API fornecido. A API pode ser um rascunho ou publicada em um catálogo específico. Você pode controlar o número de casos de teste que são listados usando os parâmetros de limite e deslocamento.
Tabela 4. Parâmetros
Parâmetro Descrição Valor Padrão
api_name Nome da API para listar os casos de teste gerados sob ela. Nenhum
catalog O nome do catálogo no qual o usuário publicou a API. Nenhum
testsuite_ name Nome do conjunto de testes para listar os casos de teste dentro dele. Nenhum
limit Número máximo de casos de teste que serão exibidos na resposta. Recebe um valor inteiro. 15
offset Ignora esse número de casos de teste e recupera os casos de teste restantes. Recebe um valor inteiro. 0
Exemplos de prompts
  • list test cases in AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • list test cases in Swagger-Petstore api
  • list test cases in Swagger-Petstore api in sandbox
  • list test cases in Swagger-Petstore api with limit 5 offset 15

Excluir Suíte de Testes

A operação delete test suite exclui um conjunto de testes, juntamente com todos os casos de teste criados dentro desse conjunto de testes.
Tabela 5. Parâmetros
Parâmetro Descrição Necessário
testsuite_name Nome do conjunto de testes que precisa ser excluído. True
Exemplo de solicitação
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

Excluir caso de teste

A operação delete test case exclui um caso de teste específico em um conjunto de testes.
Tabela 6. Parâmetros
Parâmetro Descrição Necessário
test_name Nome do caso de teste que deve ser excluído. True
testsuite_name O nome do conjunto de testes no qual o caso de teste a ser excluído está presente. True
Exemplo de solicitação
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

Publicar casos de teste

Depois de configurar e verificar seu teste, você pode publicá-lo. Esta operação publica um caso de teste específico em um conjunto de testes, se for fornecido um nome, ou todos os casos de teste no conjunto, se não for especificado um nome para o conjunto de testes.
Tabela 7. Parâmetros
Parâmetro Descrição Valor Padrão Necessário
test_name Nome do caso de teste que deve ser publicado. Nenhum True
testsuite_name O nome do conjunto de testes no qual o caso de teste que precisa ser publicado é apresentado. Nenhum True
Exemplos de prompts
  • publish test in test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • publish test AA_TEST_CASE_get/200 in test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

Obter status de teste para casos de teste

A operação Get status fornece o status de execução dos casos de teste para a API ou o conjunto de testes especificado, seja ele um rascunho ou publicado em um catálogo específico. O número de casos de teste pode ser controlado por meio dos parâmetros de limite e deslocamento.

Essa operação fornece um resumo consolidado do status do teste e do status do caso individual. Para cada caso de teste executado, ele exibe as contagens de asserções bem-sucedidas e com falha, juntamente com um link para a guia Relatório dos casos de teste no API Manager. Se um caso de teste não tiver sido executado, seu status será exibido como Not run yet para o caso de teste específico.
Tabela 8. Parâmetros
Parâmetro Descrição Valor Padrão
api_name O nome da API para a qual o status dos casos de teste deve ser obtido. Nenhum
test_name Nome do caso de teste para o qual o status deve ser obtido. Nenhum
catalog O nome do catálogo no qual o usuário publicou a API. Nenhum
testsuite_ name Nome do conjunto de testes para o qual o status deve ser obtido. Nenhum
limit O número máximo de casos de teste que serão exibidos na resposta. Recebe um valor inteiro. 15
offset Ignore esse número de casos de teste e recupere os casos de teste restantes. Recebe um valor inteiro. 0
version A versão específica da API que foi publicada ou a versão especificada na API. Nenhum
Exemplos de prompts
  • get test status for Swagger-Petstore api
  • get test status for Swagger-Petstore api in sandbox
  • get test status for Swagger-Petstore:1.0.0 api
  • get test status for Swagger-Petstore api with version 1.0.0 in sandbox
  • get test status for test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0
  • get test status for AA_TEST_CASE_get/200 in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0

Criar webhook

A operação create webhook permite a criação de um webhook para um conjunto de testes específico, possibilitando a criação de vários webhooks por conjunto. Você pode criar webhooks fornecendo um nome, uma descrição e o nome do conjunto de testes. A operação mostra o site URL do webhook criado, juntamente com orientações sobre como gerar a chave e o segredo necessários para acessar o webhook.
Acessando o gancho

Para usar o gancho da API, é necessário gerar uma chave e um segredo da API.

Para gerar uma chave e um segredo de API, conclua as etapas a seguir:
  1. Vá para o conjunto de testes > Configurações.
  2. Selecione os ganchos e as chaves da API.
  3. Na seção Keys (Chaves ), clique em Add (Adicionar ).
Tabela 9. Parâmetros
Parâmetro Descrição Valor Padrão Necessário
testsuite_name Nome do conjunto de testes para o qual o gancho deve ser criado. Nenhum True
name O gancho deve ser criado com esse nome. Nenhum True
des_hooks Descrição do gancho. "" True
Exemplos de prompts
  • create hook with name test-hook for test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0
  • create hook with name test-hook with description 'For testing purpose' for the test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0

Listar webhooks

Essa operação lista todos os webhooks criados para um determinado conjunto de testes.
Tabela 10. Parâmetros
Parâmetro Descrição Necessário
testsuite_name O nome do conjunto de testes para o qual o gancho deve ser listado. True
Exemplo de solicitação
list hooks for test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

Excluir webhooks

Esta operação exclui um webhook específico com o nome fornecido do conjunto de testes especificado.
Tabela 11. Parâmetros
Parâmetro Descrição Necessário
name Nome do gancho que precisa ser excluído. True
testsuite_name O nome do conjunto de testes no qual o gancho a ser excluído está presente. True
Exemplo de solicitação
delete hook test-hook in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0