CGWebRequestClient

CGWebRequest Client

O CGWebRequest Client é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.

Tela inicial

Ao iniciar, o CGWebRequest exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.

Coleção

Nesse painel, ficam exibidas de forma simplificada, todas as requisições criadas pelo usuário em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.

Verbo

Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna verb no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

• GET: Azul
• POST: Verde
• PUT: Amarelo
• DELETE: Vermelho
• PATCH: Roxo
• HEAD: Rosa
• OPTIONS: Marrom
• PROPFIND: Bege

Nome

A coluna request da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.

Adicionar

Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.

Menu de Contexto

Clicar com o botão direito em alguma requisição irá exibir um menu flutuante com 3 opções:

• Duplicate: Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
• Delete: Essa opção exclui a requisição selecionada.
• Exportar Curl: Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja link.

Requisição

O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações. Url

A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, caso o usuário visualize outra requisição e retorne, o valor preenchido previamente ficará salvo automaticamente. Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição. Botão enviar

Ao lado da barra de URL localiza-se o botão ‘Enviar’, que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que haja se obtenha sucesso, é necessário configurar todos os campos previamente.

Env

Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.

Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.

Toda variável possui um nome um valor, que estão representadas nas colunas Variable e Value. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves {{}} (chaves duplas):

• Nome: API
• Valor: /https://minhaapi.com/exemplo
• URL: Predefinição:API/login

Query

As queries de uma requisição ficam representadas na aba Query da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o ? na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.

Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.

Parâmetros e valores

São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá uma checkbox que inicia marcada por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.

Headers

Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba Query, os headers possuem um nome e um valor, representados pelas colunas Header e Value. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há uma checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. A checkbox vem marcada por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.

Body

Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

• Limpar: Botão que limpa todo o conteúdo do body quando clicado.
• Abrir: Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.

Resposta

O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

• Código: No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

• Tempo: O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

• Botão Salvar: Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

Response

Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.

Header

Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: Header e Value, que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

Menu superior

Collection

Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo Collection.json é criado no pasta AppData do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver link).

• Abrir: Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a AppData do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

• Salvar: Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

Environment

Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba Env do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo Env.json é criado no pasta AppData do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

• Abrir: Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a AppData do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba Env do painel de configuração de requisição.

• Salvar: Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

Opções

Exportar Curl

Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

• Copiar: Copia a cURL para a área de transferência.
• Salvar: Abre uma janela que permite a cURL em um arquivo de texto.

Timeout

Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo ‘Tempo em segundos’ ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

• OK: Salva as configurações feitas e fecha a janela.
• Cancelar: Fecha a janela sem salvar as alterações feitas.

Ajuda

Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.

Sobre

Abre uma janela com informações sobre o CGWebRequest Client.

Página da Wiki

Essa opção abre o link externo que leva até esta página.