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 do 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 do 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 Configurações na barra de navegação à esquerda.
  5. Copie o URL do Ponto Final do Token SSO localizado em URLs do 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 em seu web browser no form?clientID=[YourClientID] e, em seguida, pressione a tecla Enter. Um exemplo do URL tem a seguinte aparência:
    https://<YourSSOTokenEndpointURL>?clientID=<yourClientID>
    O browser mostrará um Token OAuth de Sign-on Único.
  9. Na sua janela de backend móvel, clique na página APIs localizada na navegação à esquerda. O browser será alterado da página Definiçõ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 seu Token OAuth do SSO e cole-o no campo Token de Sign-on Ú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 de Simulação

Você pode fornecer dados simulados em sua solicitação e corpos de mensagens de resposta durante a fase de design da sua configuração de 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 seu código trata corretamente de um ID inválido, você pode adicionar um exemplo no corpo da sua solicitação com dados simulados que contêm um ID inválido. Ao finalizar o teste, é possível substituir o exemplo por outro código para testar outro aspecto do método.

No exemplo FixItFast, os dados simulados no corpo da resposta permitem que você verifique se as informações corretas do cliente estão sendo retornadas. Aqui está um exemplo de dados simulados que o desenvolvedor de serviços 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 que você chame a API de sua aplicação móvel antes de implementar o código personalizado. Isso permite que você desenvolva e teste os aplicativos móveis e o código personalizado simultaneamente. Se estiver satisfeito com a configuração, você poderá adicionar uma implementação real.

Até que você crie sua primeira implementação, a implementação default é a implementação simulada. Depois de criar 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 quaisquer implementações existentes. Você pode alterar a implementação default na página Implementações. Após fazer upload de uma implementação, você verá uma lista de implementações existentes, que inclui a implementação simulada.

Testar a API do Conector REST

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

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

  • Testes padrão

    Se você forneceu metadados do descritor, o modo de teste padrão será exibido, no qual os corpos de solicitação e resposta são gerados com base nos 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 qualquer cabeçalho HTTP com o qual você deseja testar.

  • Testes avançados

    Você pode refinar seus testes selecionando Teste no Modo Avançado (o modo de teste informado se você forneceu um URL de serviço remoto). Sem metadados descritivos, selecione o método e o recurso para testar, inclua todos os cabeçalhos HTTP que você deseja incluir e crie manualmente o corpo JSON.

Teste em Modo Avançado

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

Para configurar manualmente um teste do conector:

  1. Clique no link de navegação Testar.
  2. Se você forneceu um descritor, ative Testar no Modo Avançado como On.

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

  3. Selecione o método HTTP que você deseja testar na lista drop-down.
  4. Especificar qualquer parâmetro de caminho do 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 definido quando você informou um nome de API. Seguindo nosso exemplo, o conteúdo completo do campo seria:

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

    Observe que, se você tiver definido regras, o campo Regras Aplicadas (abaixo do campo Corpo) exibirá números correspondentes às regras aplicáveis à operação selecionada. O campo URL Remoto mostra a string exata que será transmitida para o 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 somente para fins de teste e não serão adicionados à configuração da API do REST Connector.

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

    Mantenha o conteúdo do corpo da mensagem relevante à finalidade do conector, ou seja, não blove a mensagem adicionando dados estranhos. A inclusão apenas de 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 informe suas credenciais de usuário móvel para cada método que você testar. 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 do nome do usuário, as credenciais usadas para autenticação no serviço externo são fornecidas nas substituições de política como chaves CSF. Dependendo da operação definida, talvez você tenha de informar credenciais específicas para cada operação ou possa usar um conjunto de credenciais para todos os métodos para autenticar seu conector no serviço.

  8. Clique em Salvar como credenciais padrão de backend móvel atuais para salvar o nome de usuário e a senha que você fornecer como padrão.
  9. Se você estiver na fase de criação de 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 no qual você está registrado e seu número de versão.
    Opcionalmente, você pode informar suas credenciais de usuário móvel (nome de usuário e senha).

    Essas credenciais de teste default são persistentes em todos os métodos que você testa. Eles permanecem válidos durante a sessão em nuvem móvel atual.

  10. Clique em Testar Ponto Final.

    O Ponto Final de Teste alterna para Cancelar Teste quando você clica nele. Para interromper o teste por qualquer 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.