Usando a interface com o usuário do testador REST XAPI HTTP

Este tópico fornece detalhes sobre como usar a interface com o usuário HTTP REST XAPI Tester.

1. Acesse a interface com o usuário do HTTP REST XAPI Tester usando este URL https://<hostname>:<portno>/smcfs/yfshttpapi/ibmapitester.jsp ..
2. Na lista suspensa Nome da API , selecione a API REST que deseja testar. Ao selecionar uma API REST, o campo URL BASE é preenchido automaticamente com o caminho base da API REST.
   Nota: como o valor no campo BASE URL é reconfigurado sempre que você selecionar uma nova API REST no menu suspenso Nome da API , certifique-se de atualizar o valor no campo BASE URL prefixando-o com "https://<hostname>:<portno>" antes de fazer a chamada API para teste. Portanto, o valor deve estar no formato https://<hostname>:<portno>/smcfs/restapi/<resource_group> ..

   Nota: é possível testar apenas as APIs REST listadas no Javadoc da XAPI REST da interface com o usuário do HTTP REST XAPI Tester. É possível ignorar todas as APIs não REST relacionadas na lista suspensa.
3. Insira o nome de usuário no campo UserId e a senha no campo Senha .
4. Selecione o formato (JSON ou XML) da mensagem de entrada para a XAPI REST no campo Tipo de Conteúdo ... O tipo de conteúdo é o tipo de conteúdo da mensagem ou corpo da solicitação.
   Nota: para solicitação GET, se um Tipo de conteúdo for selecionado, a caixa de seleção Enviar sobre POST será selecionada automaticamente e também desativada. Portanto, para utilizar esses métodos sem enviar sobre o POST, certifique-se de que nenhum valor esteja selecionado para o campo Content-Type.

   Importante: ao usar o Testador REST XAPI HTTP pela primeira vez, o cabeçalho Content-Type pode não ser inicializado automaticamente, o que pode resultar em um erro 415 (Tipo de mídia não suportado) na sua solicitação inicial.

   Solução alternativa: alterne as opções do botão de opção Content-Type antes de enviar sua primeira solicitação de API. Depois que o Content-Type for definido, as solicitações subsequentes funcionarão conforme o esperado.

5. Se desejar enviar a solicitação sobre POST, marque a caixa de seleção Enviar sobre POST .
6. Selecione o formato (JSON ou XML) da mensagem de saída esperada do REST XAPI no campo Formato de Saída .
7. Opcional: use o Identificador para GET, PATCH ou XAPIs DELETE REST. Por exemplo, é possível chamar a REST XAPI getOrderDetails em um registro com OrderHeaderKey=TestOrder. O TestOrder é o identificador neste exemplo. A estrutura do HTTP REST XAPI Tester anexa automaticamente esse valor identificador no término da URL Base. Portanto, o URL completo da base passa a ser este https://<hostname>:<portno>/smcfs/restapi/order/TestOrder.
8. Opcional: Serviços também podem ser testados inserindo o nome do serviço no campo Nome do Serviço e selecionando a caixa de seleção É um serviço .
9. Opcional: O menu suspenso Histórico pode ser usado para selecionar uma chamada API anterior. Na seleção de uma API, os campos Mensagem, URL Base e Content-Type são preenchidos com os valores usados nessa chamada da API.
   Nota: como o valor no campo BASE URL é reconfigurado sempre que você selecionar uma nova API no menu suspenso Histórico , certifique-se de atualizar o valor no campo BASE URL prefixando-o com "https://<hostname>:<portno>" antes de fazer a chamada API para teste. Portanto, o valor deve estar no formato https://<hostname>:<portno>/smcfs/restapi/<resource_group> ..
10. Opcional: para salvar detalhes de uma chamada API, clique em Salvar chamadas API. O sistema solicita que o usuário salve o arquivo como Apicalls.txt. Este arquivo contém o histórico atual da entrada ou da saída de uma chamada de API. Em seguida, cada chamada API é denotada por tags <!- - start -- > and <! - - end - - > no arquivo, com o nome da API chamado listado após o comentário de início.
11. Insira a mensagem de entrada (XML ou JSON) para o REST XAPI no campo Mensagem
12. Clique em Testar XAPI de REST Agora! A mensagem de saída (XML ou JSON) é exibida na caixa de texto no lado direito.