Usando o API Agent

Editar online

Você pode usar o site API Agent para publicar e testar APIs de ponta a ponta. A seguir, há seções com detalhes sobre o que esperar ao usar o plug-in API Agent e um exemplo de cenário de fluxo de ponta a ponta, que você pode percorrer para entender como o agente funciona e os recursos disponíveis no agente.

Os administradores podem atribuir funções apropriadas para habilitar o API Agent para desenvolvedores específicos dentro da organização. Essa capacitação seletiva garante que a ferramenta seja usada de forma eficaz dentro do contexto correto. Depois que o administrador configurar os códigos-fonte, os desenvolvedores poderão instalar o plug-in Visual Studio Code e começar a integrá-lo ao seu espaço de trabalho. Para obter mais informações, consulte a seção Funções de usuário do API Agent.

Melhores práticas

A extensão API Agent é uma ferramenta usada em Visual Studio Code para auxiliar no gerenciamento da API. Para garantir o funcionamento adequado, é essencial que a janela de extensão tenha altura total e pelo menos 1/3 da largura da janela.

Compreensão dos prompts na documentação

Quando você vê um comando na documentação, é essencial entender como usá-lo corretamente.

Se um comando contiver um espaço reservado, como [apiName], você precisará substituí-lo por seu próprio texto. Por exemplo,
- Comando: Run test cases for [apiName]:[version]
- Substituição: Run test cases for bookshop-api-3:1.0
Observação: certifique-se de substituir [apiName] pelo nome real da API para executar o comando.
Para preencher o espaço reservado, como [@file]:
- O documento pode ter o seguinte prompt: remediate api [@file] using spectral-owasp ruleset. Substitua-o por remediate api @bookstore.yaml using spectral-owasp ruleset.
Para substituir [@file], é necessário acionar o símbolo @ para acessar os arquivos no espaço de trabalho Visual Studio Code. Em seguida, selecione o arquivo desejado para fazer upload para o agente.

Para iniciar uma nova sessão

Para manter a sessão ativa, é necessário limpar todos os dados temporários ou residuais que possam estar causando problemas e, em seguida, atualizar o sistema para garantir que ele esteja em um estado atualizado.

Para manter a sessão ativa e atualizada, conclua as etapas a seguir:

Digite CMD + SHIFT + P para abrir a paleta de comandos Visual Studio Code.
Na linha de comando, digite Developer: Reload window.
Na linha de comando, digite API Agent: Logout.
Observação: esse comando remove sua sessão de login, mas você precisa fazer o processo de autenticação novamente. No entanto, as informações de login ( pOrg, login URL, entre outras) ainda são armazenadas em cache
Para remover todas as informações de login armazenadas em cache após o logout, na linha de comando, digite API Agent: Clear session from workspace state and reload.
Observação: Quando um plug-in é excluído ou desativado em Visual Studio Code, as informações de login armazenadas em cache persistem. Isso significa que, quando você baixar novamente o plug-in, o campo URL é preenchido com seu último URL usado.

Processo de depuração

Para fins de depuração, há duas áreas a serem exploradas na paleta de comandos Visual Studio Code.

Para visualizar o lado Visual Studio Code da extensão, conclua as etapas a seguir:

Digite CMD + SHIFT + P para abrir a paleta de comandos Visual Studio Code.
Na linha de comando, digite Show Output Channels e selecione o comando na lista.
Na lista de canais de saída, selecione API Agent Debug Logs.
Visual Studio Code exibe as seguintes informações:
- Dados de login e de sessão.
- Reinicialização da extensão depois de alterar as guias.

Para ver o lado da visualização da Web do bate-papo, conclua as etapas a seguir:

Digite CMD + SHIFT + P para abrir a paleta de comandos Visual Studio Code.
Na linha de comando, digite Developer: Open Webview Developer Tools e selecione o comando na lista.
Você pode visualizar as ferramentas de desenvolvedor da webview, onde pode acessar as seguintes informações:
- Guia Console: visualize os registros e a saída do console
- Guia Rede: inspecione as chamadas REST que estão sendo feitas

Anexar e fazer download de arquivos

Para anexar e fazer download de um arquivo, conclua as etapas a seguir:

Para anexar um arquivo, você deve acionar o menu de arquivos digitando @ e, em seguida, selecionando o arquivo.
Observação: O tamanho máximo do arquivo é de 1 GB e o nome do arquivo não deve conter espaços ou caracteres especiais.
Se você copiou e colou um comando como validate api @testapi.yaml, exclua o comando base validate api e digite novamente @ para acionar o menu file.
Selecione um arquivo no menu de arquivos que aparece depois de digitar @.
Quando um botão de próxima ação inclui uma referência a um arquivo, por exemplo, remediate api [@file] using spectral-owasp ruleset, você deve substituir [@file] por um arquivo recém-anexado, acionando o menu de arquivo com o símbolo @ .
Para excluir o nome do arquivo na linha de comando, exclua o comando e digite novamente validate api.

API Agent problemas de recarga e logout

Se você não usar o bate-papo por um tempo, o token usado com API Connect expirará durante esse período e, se você continuar a conversar, ele exibirá um Error: Unauthorized e fará o logout automático. Você precisa fazer o processo de login novamente.
Para limpar corretamente os recursos, você deve usar a opção de logout no plug-in, em vez da opção de logout gerenciada pelo Visual Studio Code.
Importante: o plug-in API Agent foi renomeado de API Assistant. Se você tiver a versão antiga, exclua-a antes de fazer o download da nova versão.

Uso de pilha diferente ou login com usuário diferente na mesma pilha

Após fazer logout de uma pilha ou usuário, limpe a sessão do estado do espaço de trabalho; o API Agent pode usar informações desatualizadas ao mudar para outro, resultando em problemas de persistência.

Para resolver esse problema, conclua as etapas a seguir:

Efetua o logout da pilha ou do usuário atual.
Na paleta Command, execute o seguinte comando:
```
API Agent: Clear session from workspace state
```
Recarregar a página.
Faça login com a nova pilha ou usuário.