Pontx Hub

O que Pontx Hub faz?

Use pontx-hub como a interface autoritativa para o catálogo de APIs curadas. Mantenha os metadados das APIs fora do contexto de longa duração, pesquisando e carregando apenas o produto, endpoint ou esquema necessário para a tarefa atual.

Fluxo de Trabalho

1. Pesquise antes de escolher uma API. São suportadas consultas em linguagem natural sobre capacidade, requisição e resposta:

   pontx-hub search "<capacidade>" --json
   pontx-hub search "parâmetros de entrada da tarefa" --locale pt --json
   pontx-hub search "interface que retorna dueDate" --locale pt --json
   

   Reduza o tipo de resultado quando for útil:

   pontx-hub search "<campo-ou-modelo>" --type schema --json
   

2. Inspecione o ID do recurso estável selecionado:

   pontx-hub show endpoint:<api>/<endpoint>
   pontx-hub show schema:<api>/<schema>
   

3. Para um endpoint, monte e revise a requisição exata sem enviá-la:

   pontx-hub <coleção-api> preview <nome-da-api> --parameter valor --body '<json>'
   pontx-hub <coleção-api> preview <controlador> <nome-da-api> --parameter valor --body '<json>'
   

4. Para GET ou HEAD, chame somente quando o usuário solicitar a execução:

   pontx-hub <coleção-api> call <nome-da-api> --parameter valor
   pontx-hub <coleção-api> call <controlador> <nome-da-api> --parameter valor
   

5. Para POST, PUT, PATCH ou DELETE, mostre o resultado da simulação (dry-run) e obtenha confirmação explícita do usuário. Em seguida, passe --yes sem alterar os parâmetros:

   pontx-hub <coleção-api> call <controlador> <nome-da-api> --parameter valor --body '<json>' --yes
   

6. Gere o código de integração após a forma da requisição ser verificada:

   pontx-hub sdk <api>
   

Segurança

• Nunca inferir aprovação para uma escrita a partir de uma requisição de inspeção, explicação ou pré-visualização de uma API.
• Nunca imprimir, ecoar, registrar ou colocar credenciais diretamente nos argumentos do comando.
• Ler credenciais das variáveis de ambiente nomeadas por show.
• Nunca chamar uma URL arbitrária ou uma operação fora do catálogo Hub.
• Nunca pular a etapa separada de preview para uma mutação.
• Tratar um parâmetro, corpo, servidor ou operação alterados como uma nova requisição que requer outra simulação e confirmação.
• Leia references/auth-and-safety.md ao configurar credenciais, diagnosticar autenticação ou executar uma mutação.

Saída

Prefira --json ao consumir a saída da CLI programaticamente. Preserve o código de saída da CLI e o código de erro legível por máquina ao relatar falhas. Use o match.mode e match.fields do resultado para explicar se o produto, parâmetro, requisição, resposta, esquema ou propriedade produziu a correspondência. Use o pacote @pontx/<slug-da-api> publicado da operação ao gerar código de aplicação.