pontjs/pontx-hub

Pontx Hub

Utilisez pontx-hub comme interface de référence pour le catalogue d'APIs organisé. Évitez d'alourdir le contexte à long terme avec des métadonnées d'API en recherchant et en chargeant uniquement le produit, le point de terminaison ou le schéma nécessaire à la tâche en cours.

Workflow

1. Recherchez avant de choisir une API. Les questions en langage naturel, sur les capacités, les requêtes et les réponses sont prises en charge :

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

   Réduisez le type de résultat si nécessaire :

   pontx-hub search "<champ-ou-modèle>" --type schema --json
   

2. Inspectez l'ID de ressource stable sélectionné :

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

3. Pour un point de terminaison, construisez et examinez la requête exacte sans l'envoyer :

   pontx-hub <api-collection> preview <api-name> --parameter value --body '<json>'
   pontx-hub <api-collection> preview <controller> <api-name> --parameter value --body '<json>'
   

4. Pour GET ou HEAD, appelez uniquement lorsque l'utilisateur a demandé l'exécution :

   pontx-hub <api-collection> call <api-name> --parameter value
   pontx-hub <api-collection> call <controller> <api-name> --parameter value
   

5. Pour POST, PUT, PATCH ou DELETE, affichez le résultat de l'exécution à sec et obtenez une confirmation explicite de l'utilisateur. Passez ensuite --yes sans modifier les paramètres :

   pontx-hub <api-collection> call <controller> <api-name> --parameter value --body '<json>' --yes
   

6. Générez le code d'intégration une fois la forme de la requête vérifiée :

   pontx-hub sdk <api>
   

Sécurité

• Ne déduisez jamais une approbation pour une écriture à partir d'une demande d'inspection, d'explication ou de prévisualisation d'une API.
• N'imprimez, n'affichez, ne journalisez ni ne placez jamais d'identifiants directement dans les arguments de commande.
• Lisez les identifiants à partir des variables d'environnement nommées par show.
• N'appelez jamais une URL arbitraire ou une opération en dehors du catalogue Hub.
• Ne contournez jamais l'étape de preview séparée pour une mutation.
• Considérez un paramètre, un corps, un serveur ou une opération modifié comme une nouvelle requête nécessitant une nouvelle exécution à sec et une confirmation.
• Consultez references/auth-and-safety.md lors de la configuration des identifiants, du diagnostic d'authentification ou de l'exécution d'une mutation.

Sortie

Privilégiez --json lors de l'utilisation de la sortie CLI de manière programmatique. Préservez le code de sortie CLI et le code d'erreur lisible par machine lors du signalement des échecs. Utilisez les champs match.mode et match.fields du résultat pour expliquer si ce sont les métadonnées du produit, du paramètre, de la requête, de la réponse, du schéma ou de la propriété qui ont produit la correspondance. Utilisez le package @pontx/<api-slug> publié de l'opération lors de la génération du code d'application.