Testar APIs Personalizadas

No Oracle Mobile Hub, você pode testar suas APIs personalizadas antes que elas sejam implantadas usando dados simulados. Você também pode testar seus conectores REST usando a página de teste que suporta dois modos: Teste padrão e Teste avançado.

Testar uma API Personalizada do Oracle Mobile Hub

Para testar sua API personalizada diretamente no Oracle Mobile Hub:

  1. Acesse o Oracle Mobile Hub.
  2. Clique no ícone de menu e, em seguida, expanda Desenvolvimento e clique em Backends.
  3. Selecione seu backend móvel e clique em Abrir.
  4. Clique em Definições na barra de navegação esquerda.
  5. Copie o URL do Ponto Final do Token SSO localizado em URLs de Ambiente.
  6. Cole o URL copiado em uma janela do Web browser, mas não pressione a tecla Enter.
  7. Copie o ID do cliente localizado na seção Consumidor OAuth.
  8. Adicione um parâmetro de string de consulta ao URL do ponto final do token SSO colado no web browser no formato?clientID=[YourClientID] e pressione a tecla Enter. Um exemplo do URL é semelhante a este:
    https://<YourSSOTokenEndpointURL>?clientID=<yourClientID>
    O browser mostrará um Token OAuth de Sign-On Único.
  9. Na janela de backend móvel, clique na página APIs localizada na navegação esquerda. O navegador será alterado da página Configurações para a página APIs.
  10. Clique em Selecionar APIs.
  11. Clique no nome da API que você deseja testar. Uma nova página é aberta mostrando os pontos finais da API na navegação esquerda, bem como as guias Solicitação e Resposta.
  12. Clique no ponto final que você deseja testar.
  13. Na seção Autenticação, selecione Token de Sign-on Único no Método de Autenticação.
  14. Copie o Token OAuth do SSO e cole-o no campo Tokeno de Signon Único.
  15. Clique em Testar Ponto Final. Se tudo estiver correto, o servidor responderá com o status 200 e você deverá ver os dados JSON na resposta.

Testar Pontos Finais de API Usando Dados Simulados

Você pode fornecer dados simulados em seus corpos de mensagem de solicitação e resposta durante a fase de design da configuração da API. Isso permite examinar o contexto de cada chamada sem precisar usar dados em tempo real ou interagir com um serviço em tempo real. Por exemplo, para testar se o código trata corretamente um ID inválido, você pode adicionar um exemplo no corpo da solicitação com dados simulados que contêm um ID inválido. Quando terminar o teste, você poderá substituir o exemplo por outro código para testar algum outro aspecto do método.

No exemplo FixItFast, os dados simulados no corpo da resposta permitem verificar se as informações corretas do cliente estão sendo retornadas. Veja um exemplo de dados simulados que o desenvolvedor de serviço pode criar para o corpo de resposta da operação POST do recurso contact no exemplo FixItFast:
{
 "id": 20934,
 "title": "Lynn's Leaking Water Heater",
       "contact": {
       "name": "Lynn Adams",
       "street": "45 O'Connor Street",
       "city": "Ottawa",
       "postalcode": "ala1a1"
       "username":"johneta"
       }
 "status": "new",
 "driveTime": 30,
 "priority": "high",
 "createdon": "2015-04-23 18:12:03 EDT"
}

Quando você cria uma API personalizada, uma implementação simulada é criada automaticamente. A implementação simulada permite chamar a API do seu aplicativo móvel antes de implementar o código personalizado. Isso permite desenvolver e testar os aplicativos móveis e o código personalizado simultaneamente. Se você estiver satisfeito com a configuração, poderá adicionar uma implementação real.

Até você criar sua primeira implementação, a implementação padrão é a implementação simulada. Depois que você cria uma implementação real, ela se torna a implementação padrão da API.

Clique no link de navegação Implementações para fazer upload de uma implementação ou para ver qualquer implementação existente. Você pode alterar a implementação padrão na página Implementações. Depois de fazer upload de uma implementação, você verá uma lista de implementações existentes, que inclui a implementação simulada.

Testar a API de Conector REST

Agora que você definiu sua API Conector REST e salvou a configuração, verifique se pode enviar uma solicitação e receber os resultados esperados do web service. Testar uma conexão é uma etapa opcional, mas pode economizar tempo identificando e corrigindo problemas agora antes de finalizar a API do conector. A página Teste permite testar um ponto final de cada vez.

Se você forneceu um descritor, tem dois modos de teste para escolher:

  • Teste padrão

    Se você tiver fornecido metadados do descritor, o modo de teste padrão será exibido no qual os corpos de solicitação e resposta serão gerados a partir dos metadados descritivos e exibidos nas guias Solicitação e Resposta. Tudo o que você precisa fazer é selecionar os parâmetros para testar os métodos GET e incluir quaisquer cabeçalhos HTTP com os quais você deseja testar.

  • Testes avançados

    Você pode refinar seu teste selecionando Testando no Modo Avançado (o modo de teste que você informa se forneceu um URL de serviço remoto). Sem metadados descritivos, você seleciona o método e o recurso a serem testados, inclui todos os cabeçalhos HTTP que deseja incluir e cria manualmente o corpo JSON.

Testar no Modo Avançado

A página de teste avançado permite definir manualmente parâmetros de caminho, adicionar cabeçalhos e os payloads de solicitação e resposta.

Para configurar manualmente um teste de conector:

  1. Clique no link de navegação Testar.
  2. Se você tiver fornecido um descritor, gire Testar no Modo Avançado para On.

    A página de teste avançado será exibida automaticamente se você tiver fornecido um url de serviço remoto.

  3. Selecione na lista drop-down o método HTTP que você deseja testar.
  4. Especifique quaisquer parâmetros de caminho de recurso no campo URI Local conforme necessário para fins de teste. Por exemplo:
    directions/json?origin=los+angeles&destination=seattle

    O campo é prefixado automaticamente com o URI local que você definiu quando informou um nome de API. Seguindo nosso exemplo, o conteúdo completo do campo ficaria assim:

    myMapAPI /directions/json?origin=los+angeles&destination=seattle

    Observe que, se você definiu alguma regra, o campo Regras aplicadas (abaixo do campo Corpo) exibe números que correspondem às regras aplicáveis à operação selecionada. O campo URL Remoto mostra a string exata que será transmitida ao serviço para o teste.

  5. Adicione um ou mais cabeçalhos HTTP de solicitação ou resposta, conforme necessário.

    Esses cabeçalhos são apenas para fins de teste e não serão adicionados à configuração da API do Conector REST.

  6. Clique no campo Corpo HTTP para criar o corpo da mensagem (o payload) no editor de origem.
    Por exemplo:
    {
      "status":"ZERO_RESULTS",
      "routes":[ ]
    }

    Mantenha o conteúdo do corpo da mensagem relevante para a finalidade do conector, ou seja, não incha a mensagem adicionando dados estranhos. Incluir apenas dados pertinentes no corpo da mensagem facilita a transmissão rápida da solicitação ou resposta.

  7. Se o serviço ao qual você está se conectando exigir autenticação, abra a seção Autenticação e digite as credenciais de usuário móvel para cada método testado. Se você estiver usando credenciais de teste padrão, poderá ignorar esta etapa.

    Com políticas de segurança baseadas em SAML, a identidade do usuário que está fazendo a chamada é propagada para o serviço externo. Para outras políticas de segurança, como Autenticação Básica HTTP e token de nome de usuário, as credenciais usadas para autenticação com o serviço externo são fornecidas nas substituições de política como chaves CSF. Dependendo da operação que você definiu, talvez seja necessário informar credenciais específicas para cada operação ou talvez seja possível usar um conjunto de credenciais para todos os métodos para autenticar seu conector com o serviço.

  8. Clique em Salvar como credenciais padrão de backend móvel atual para salvar o nome de usuário e a senha fornecidos como padrão.
  9. Se você estiver na fase de design da criação do seu conector e quiser ver se seus pontos finais são válidos, clique em Credenciais de Teste do Designer de API Padrão e selecione um backend móvel com o qual você está registrado e seu número de versão.
    Opcionalmente, você pode inserir suas credenciais de usuário móvel (nome do usuário e senha).

    Essas credenciais de teste padrão são persistentes em todos os métodos testados. Eles permanecem válidos durante a sessão atual do Mobile Hub.

  10. Clique em Testar Ponto Final.

    Ponto Final de Teste alterna para Cancelar Teste quando você clica nele. Se quiser interromper o teste por algum motivo, clique em Cancelar Teste.

    Clique em Redefinir para limpar os campos e modificar os parâmetros de teste.

  11. Clique em Concluído quando terminar de testar seus pontos finais.