xh - Folha de Dicas do Cliente HTTP Moderno

Instalação

Plataforma	Comando
Ubuntu/Debian	`curl -sfL https://raw.githubusercontent.com/ducaale/xh/master/install.sh \
Arch Linux	`pacman -S xh`
Fedora/RHEL	`dnf install xh`
macOS (Homebrew)	`brew install xh`
macOS (MacPorts)	`sudo port install xh`
Windows (Scoop)	`scoop install xh`
Windows (Chocolatey)	`choco install xh`
Cargo (All platforms)	`cargo install xh`
Docker	`docker pull ducaale/xh`
Snap	`snap install xh`

Comandos Básicos

Comando	Descrição
`xh httpbin.org/get`	Solicitação GET simples
`xh POST httpbin.org/post name=John`	Solicitação POST com dados JSON
`xh PUT httpbin.org/put status=active`	Solicitação PUT com dados
`xh PATCH httpbin.org/patch email=new@email.com`	Solicitação PATCH para atualizar recurso
`xh DELETE httpbin.org/delete`	Solicitação DELETE
`xh HEAD httpbin.org/get`	Solicitação HEAD (apenas cabeçalhos)
`xh OPTIONS httpbin.org/get`	Solicitação OPTIONS
`xh httpbin.org/get search==rust`	GET com parâmetro de consulta
`xh httpbin.org/get page==1 limit==10`	Múltiplos parâmetros de consulta
`xh -a user:pass httpbin.org/basic-auth/user/pass`	Autenticação básica
`xh -A bearer -a token123 api.example.com`	Autenticação de token Bearer
`xh httpbin.org/get User-Agent:CustomAgent`	Cabeçalho personalizado
`xh -b httpbin.org/json`	Imprimir apenas corpo da resposta
`xh -h httpbin.org/json`	Imprimir apenas cabeçalhos de resposta
`xh -v httpbin.org/json`	Saída detalhada (cabeçalhos + corpo)
`xh httpbin.org/json -o response.json`	Baixar resposta para arquivo
`xh --follow=0 httpbin.org/redirect/3`	Não siga redirecionamentos
`xh -f POST httpbin.org/post name=John`	POST com dados de formulário
`xh POST httpbin.org/post < data.json`	POST com conteúdo de arquivo
`xh httpbin.org/get Authorization:"Bearer token"`	Cabeçalho de Autorização

Uso Avançado

Comando	Descrição
`xh POST httpbin.org/post age:=30 active:=true`	JSON com coerção de tipo (número/booleano)
`xh POST httpbin.org/post tags:='["rust","cli"]'`	Enviar array JSON
`xh POST httpbin.org/post user[name]=John user[age]:=30`	Objetos JSON aninhados
`xh --session=mysession httpbin.org/cookies/set/token/abc`	Criar sessão nomeada (persistir cookies)
`xh --session=mysession httpbin.org/cookies`	Reutilizar sessão
`xh --session-read-only=mysession httpbin.org/get`	Usar sessão sem atualizá-la
`xh -f POST httpbin.org/post file@/path/to/file.txt`	Carregar arquivo como formulário multipart
`xh POST httpbin.org/post @file.json`	Carregar arquivo como corpo da solicitação
`xh --proxy=http:http://proxy.example.com:8080 httpbin.org/get`	Usar proxy HTTP
`xh --proxy=all:socks5://localhost:1080 httpbin.org/get`	Use proxy SOCKS5
`xh --verify=no https://self-signed.badssl.com/`	Ignorar verificação SSL (inseguro)
`xh --cert=/path/to/ca-cert.pem https://api.example.com`	Certificado de CA personalizado
`xh --cert=/path/to/client.crt --cert-key=/path/to/client.key https://api.example.com`	Autenticação de certificado de cliente
`xh --timeout=30 httpbin.org/delay/5`	Definir tempo limite de solicitação (segundos)
`xh --pretty=none httpbin.org/json`	Desativar saída colorida/formatada
`xh --style=monokai httpbin.org/json`	Use um esquema de cores específico
`xh --stream httpbin.org/stream/100`	Resposta de stream
`xh --download httpbin.org/image/png -o image.png`	Baixar com barra de progresso
`xh --continue httpbin.org/stream/100 -o stream.txt`	Retomar download parcial
`xh --http-version=1.1 https://httpbin.org/get`	Forçar HTTP/1.1
`xh --method=CUSTOM httpbin.org/anything`	Método HTTP personalizado
`xh --multipart POST httpbin.org/post name=John file@doc.pdf`	Formulário multipart com dados mistos
`xh httpbin.org/get Cookie:session=abc123`	Enviar cookies
`xh --auth-type=digest -a user:pass httpbin.org/digest-auth/auth/user/pass`	Autenticação Digest

Tipos de Dados JSON

Ao enviar dados JSON, xh suporta coerção de tipos com sintaxe especial:

Sintaxe	Tipo	Exemplo
`key=value`	String	`name=John` → `{"name":"John"}`
`key:=number`	Número	`age:=30` → `{"age":30}`
`key:=true`	Boolean	`active:=true` → `{"active":true}`
`key:=null`	Nulo	`middle:=null` → `{"middle":null}`
`key:='[...]'`	Vetor	`tags:='["a","b"]'` → `{"tags":["a","b"]}`
`key:='{...}'`	Objeto	`meta:='{"v":1}'` → `{"meta":{"v":1}}`
`key[sub]=value`	Aninhado	`user[name]=John` → `{"user":{"name":"John"}}`

Configuração

Locais de Armazenamento de Sessão

# Linux/macOS
~/.config/xh/sessions/

# Windows
%APPDATA%\xh\sessions\

Variáveis de Ambiente

# Set default proxy
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080

# Disable proxy for specific hosts
export NO_PROXY=localhost,127.0.0.1,.example.com

# Default timeout
export XH_TIMEOUT=30

Aliases Comuns

# Add to ~/.bashrc or ~/.zshrc

# HTTPie compatibility
alias http='xh'
alias https='xh --default-scheme=https'

# Quick shortcuts
alias xhj='xh --pretty=all'  # Force JSON pretty-print
alias xhn='xh --pretty=none' # No formatting
alias xhv='xh -v'            # Verbose by default
alias xhd='xh --download'    # Download mode

Casos de Uso Comuns

Caso de Uso: Testando REST API com Autenticação

# Login and save session
xh --session=api POST https://api.example.com/login \
  username=admin password=secret

# Make authenticated requests using saved session
xh --session=api GET https://api.example.com/users

# Update resource
xh --session=api PUT https://api.example.com/users/123 \
  name="John Doe" email=john@example.com status=active

# Delete resource
xh --session=api DELETE https://api.example.com/users/123

Caso de Uso: Upload de Arquivo com Metadados

# Upload file with additional form fields
xh -f POST https://api.example.com/upload \
  file@/path/to/document.pdf \
  title="Important Document" \
  category=legal \
  tags:='["contract","2024"]'

# Multiple file upload
xh -f POST https://api.example.com/batch-upload \
  file1@image1.jpg \
  file2@image2.jpg \
  album="Vacation 2024"

Caso de Uso: Testando API em Diferentes Ambientes

# Development environment
xh --session=dev POST https://dev-api.example.com/test \
  Authorization:"Bearer dev-token-123" \
  data=test

# Staging environment
xh --session=staging POST https://staging-api.example.com/test \
  Authorization:"Bearer staging-token-456" \
  data=test

# Production environment (with SSL verification)
xh --session=prod POST https://api.example.com/test \
  Authorization:"Bearer prod-token-789" \
  data=test

Caso de Uso: Depurando Payloads de Webhook

# Capture webhook payload to file
xh POST https://webhook.site/your-unique-url \
  event=user.created \
  user[id]:=12345 \
  user[email]=new@example.com \
  timestamp:=$(date +%s) \
  -v -o webhook-debug.txt

# Test webhook with retry logic (in script)
for i in {1..3}; do
  xh POST https://your-app.com/webhook \
    event=test \
    attempt:=$i && break || sleep 5
done

Caso de Uso: Baixando e Processando Dados de API

# Download JSON data
xh GET https://api.github.com/users/octocat/repos \
  -o repos.json

# Download with authentication and save
xh -a token:ghp_your_token \
  GET https://api.github.com/user/repos \
  visibility==private \
  -o private-repos.json

# Stream large dataset
xh --stream GET https://api.example.com/export/data \
  format==json \
  | jq '.[] | select(.active == true)' \
  > active-records.json

Melhores Práticas

Use sessões para fluxos autenticados: Sessões mantêm cookies e cabeçalhos, eliminando a necessidade de re-autenticar para cada requisição. Use --session=namepara interações de API em múltiplas etapas.
Aproveite a coerção de tipos para JSON: Use :=para números e booleanos (age:=30, active:=true) em vez de valores de string para garantir tipos JSON corretos em requisições de API.
Prefira xh ao invés de curl para testes de API: A sintaxe intuitiva (xh POST api.com name=value) é mais legível do que os flags verbosos do curl, tornando-o ideal para documentação e testes rápidos.
Use modo verbose para depuração: Adicione -vpara ver cabeçalhos completos de requisição e resposta ao solucionar problemas de API ou autenticação.
Armazene tokens sensíveis em variáveis de ambiente: Em vez dexh -a token:secret_key, use xh -a token:$API_TOKENpara evitar expor credenciais no histórico do shell. -o file.json- Utilize redirecionamento de saída para automação: Salve respostas com para processamento ou comparação em pipelines de CI/CD e scripts de teste automatizados. --timeout=30- Defina timeouts apropriados: Use para APIs lentas para prevenir solicitações travadas. Defina --timeout=0apenas para operações de streaming ou de longa duração. --session=prod-api- Organize sessões por ambiente: Crie sessões separadas para desenvolvimento, staging e produção () para evitar o uso acidental de credenciais erradas.

Resolução de Problemas

Problema	Solução
`SSL certificate verification failed`	Use `--verify=no` to skip verification (insecure) or `--cert=/path/to/ca.pem` to provide custom CA certificate
`Connection timeout`	Increase timeout with `--timeout=60` or check network connectivity and proxy settings
`401 Unauthorized`	Verify authentication method: use `-a user:pass` for basic auth, `-A bearer -a token` for bearer tokens, or check session validity
`JSON parsing error`	Ensure proper syntax: use `:=` for non-strings (`age:=30`), quote arrays (`tags:='["a","b"]'`), and check for unescaped special characters
`Command not found: xh`	Verify installation path is in `$PATH`, reinstall using preferred method, or use full path `/usr/local/bin/xh`
`Session not persisting`	Check session directory permissions (`~/.config/xh/sessions/`), ensure using same session name, verify not using `--session-read-only`
`Proxy connection failed`	Verify proxy URL format `--proxy=http:http://host:port`, check proxy authentication if required, ensure proxy allows target host
`File upload fails`	Use `-f` or `--multipart` flag for form uploads, verify file path is correct, check file permissions and size limits
`Response not formatted/colored`	Force formatting with `--pretty=all`, check terminal supports colors, or pipe through `jq` for JSON formatting

Would you like me to clarify or modify anything about the translation?