pontx-hub

Pontx Hub

Utiliza pontx-hub como la interfaz oficial para el catálogo de APIs curado. Mantén los metadatos de las APIs fuera del contexto de larga duración buscando y cargando solo el producto, punto final o esquema necesario para la tarea actual.

Flujo de trabajo

1. Busca antes de elegir una API. Se admiten consultas en lenguaje natural sobre capacidades, solicitudes y respuestas:

   pontx-hub search "<capacidad>" --json
   pontx-hub search "创建任务的入参" --locale zh --json
   pontx-hub search "返回 dueDate 的接口" --locale zh --json
   

   Limita el tipo de resultado cuando sea útil:

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

2. Inspecciona el ID de recurso estable seleccionado:

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

3. Para un punto final, construye y revisa la solicitud exacta sin enviarla:

   pontx-hub <colección-api> preview <nombre-api> --parameter valor --body '<json>'
   pontx-hub <colección-api> preview <controlador> <nombre-api> --parameter valor --body '<json>'
   

4. Para GET o HEAD, llama solo cuando el usuario haya solicitado la ejecución:

   pontx-hub <colección-api> call <nombre-api> --parameter valor
   pontx-hub <colección-api> call <controlador> <nombre-api> --parameter valor
   

5. Para POST, PUT, PATCH o DELETE, muestra el resultado de la previsualización (dry-run) y obtén la confirmación explícita del usuario. Luego pasa --yes sin cambiar los parámetros:

   pontx-hub <colección-api> call <controlador> <nombre-api> --parameter valor --body '<json>' --yes
   

6. Genera código de integración una vez que la forma de la solicitud esté verificada:

   pontx-hub sdk <api>
   

Seguridad

• Nunca inferir la aprobación para una escritura a partir de una solicitud de inspección, explicación o previsualización de una API.
• Nunca imprimir, mostrar en pantalla, registrar o colocar credenciales directamente en los argumentos del comando.
• Leer las credenciales de las variables de entorno nombradas por show.
• Nunca llamar a una URL arbitraria ni a una operación fuera del catálogo de Hub.
• Nunca omitir el paso separado de preview para una mutación.
• Tratar un parámetro, cuerpo, servidor u operación cambiados como una nueva solicitud que requiere otra previsualización y confirmación.
• Leer references/auth-and-safety.md al configurar credenciales, diagnosticar autenticación o ejecutar una mutación.

Salida

Preferir --json al consumir la salida de la CLI de forma programática. Conservar el código de salida de la CLI y el código de error legible por máquina al informar fallos. Usar el match.mode y match.fields del resultado para explicar si los metadatos del producto, parámetro, solicitud, respuesta, esquema o propiedad produjeron la coincidencia. Usar el paquete @pontx/<api-slug> publicado de la operación al generar código de aplicación.