Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

NESTA PÁGINA
 

Exemplo: usando o REST API Explorer

Este exemplo demonstra como usar opcionalmente o API Explorer REST em um dispositivo Junos OS no qual a API REST foi configurada.

Requisitos

  • É necessário um Série M, série MX, Série T ou série PTX que executa a versão 14.2 do Junos OS.

Visão geral

O REST API Explorer permite que você teste convenientemente chamadas RPC individuais ou múltiplas. Sua GUI fornece opções para selecionar o método HTTP (GET ou POST), o formato de saída necessário (XML, JSON ou texto simples), a URL RPC, o tipo de dados de entrada ao usar solicitações POST (XML ou texto simples) e uma condição de saída no erro. Quando você envia a solicitação, o REST API Explorer exibe o header de solicitação, o header de resposta, o corpo de resposta e a solicitação de cURL equivalente, tudo isso útil para seus esforços de desenvolvimento.

Configuração

Para usar o REST API Explorer em qualquer dispositivo no qual a API REST tenha sido configurada, realize essas tarefas:

Ativação do REST API Explorer

Procedimento passo a passo

Para habilitar o REST API Explorer:

  1. Configure a API REST no dispositivo.

    Consulte Configurar a API e o Exemplo REST: configurar a API REST para obter informações e exemplos.

  2. Verificar se o REST API Explorer está ativado.

    Use o show comando para ver se aparece na enable-explorer; configuração da API REST. Se aparecer, o REST API Explorer foi ativado. Caso ele não apareça, você deve habilitar o REST API Explorer.

  3. Ative o REST API Explorer, se necessário.

    Use o set comando para garantir que isso apareça na enable-explorer; configuração da API REST.

Abertura do REST API Explorer

Procedimento passo a passo

Para abrir o REST API Explorer:

  • Certifique-se de que o REST API Explorer está ativado, abra um navegador e vá para a URL a seguir: nome scheme://device nome:porta (por exemplo, https://mydevice:3000).

Execução de um único RPC usando uma solicitação HTTP GET

Procedimento passo a passo

Para executar um único RPC usando uma solicitação HTTP GET:

  1. Na lista de espera do método HTTP, selecione GET.

  2. Insira o endpoint da URL RPC.

    Por exemplo, tipo /rpc/get-software-information .

  3. Insira seu nome de usuário e senha.

  4. Clique em Enviar.

    Neste exemplo, o formato de saída padrão, XML, é devolvido no Corpo de Resposta:

Execução de um único RPC usando uma solicitação HTTP POST

Procedimento passo a passo

Para executar um único RPC usando uma solicitação HTTP POST:

  1. Na lista de espera do método HTTP, selecione POST.

  2. Na lista drop-down do formato de saída obrigatório, selecione JSON.

  3. Insira este endpoint da URL RPC: /rpc/get-software-information .

  4. Insira seu nome de usuário e senha.

  5. Insira a solicitação formatada por XML na área de texto do corpo da solicitação.

    Por exemplo:

  6. Clique em Enviar.

    Neste exemplo, o formato de saída JSON é devolvido no Corpo de Resposta:

  7. Se você preferir um formato de saída diferente, selecione uma das opções disponíveis na lista de opções listadas no formato de saída obrigatório.

    Por exemplo, você pode selecionar texto simples. Ao clicar em Enviar,você verá texto simples no Corpo de Resposta:

    Da mesma forma, se você selecionar XML na lista de seleção do formato de saída obrigatório, o corpo de resposta conterá informações formatadas por XML:

Execução de vários RPCs

Procedimento passo a passo

Para executar vários RPCs:

  1. Na lista de espera do método HTTP, selecione POST.

    Isso sempre é necessário ao executar vários RPCs.

  2. Para definir uma saída condicional no caso de erro, selecione a caixa de seleção Sair na caixa de seleção de erros.

  3. Selecione um formato de saída na lista de seleção do formato de saída obrigatório.

    Por exemplo, você pode selecionar JSON.

  4. Este endpoint de URL RPC preencherá automaticamente: /rpc?exit-on-error=1 .

  5. Insira seu nome de usuário e senha.

  6. Insira a solicitação formatada por XML na área de texto do corpo da solicitação.

    Por exemplo:

  7. Clique em Enviar.

    Neste exemplo, o formato de saída JSON é devolvido no Corpo de Resposta:

Exibição de mensagens de erro

Procedimento passo a passo

Ao executar vários RPCs, pode ocorrer um erro. Se você selecionar a caixa de seleção Sair na caixa de seleção de erros, uma mensagem de erro aparecerá na saída caso ocorra um erro.

Para exibir mensagens de erro:

  1. Na lista de seleção do método HTTP, selecione POST.

    Isso sempre é necessário ao executar vários RPCs.

  2. Para definir uma saída condicional no caso de erro, selecione a caixa de seleção Sair na caixa de seleção de erros.

  3. Selecione um formato de saída na lista de seleção do formato de saída obrigatório.

    Por exemplo, você pode selecionar JSON.

  4. Este endpoint de URL RPC preencherá automaticamente: /rpc?exit-on-error=1 .

  5. Insira seu nome de usuário e senha.

  6. Insira a solicitação formatada por XML contendo um erro na área de texto do corpo da solicitação.

    Por exemplo:

  7. Clique em Enviar.

    Neste exemplo, o formato de saída JSON é devolvido no Corpo de Resposta, e você pode ver uma mensagem de erro formatada em XML ao final do corpo de resposta:

  8. Se você não selecionar a caixa de seleção Sair na caixa de seleção de erros, uma mensagem de erro será exibida no Corpo de Resposta caso ocorra um erro.

    A execução continuará após o erro ser processado, e os resultados também serão incluídos no Corpo de Resposta:

Documentação relacionada