pontjs/pontx-hub

Pontx Hub

Verwende pontx-hub als maßgebliche Schnittstelle zum kuratierten API-Katalog. Halte API-Metadaten aus dem Langzeitkontext fern, indem du nur das Produkt, den Endpunkt oder das Schema suchst und lädst, das für die aktuelle Aufgabe benötigt wird.

Workflow

1. Suche, bevor du eine API auswählst. Abfragen in natürlicher Sprache zu Fähigkeiten, Anfragen und Antworten werden unterstützt:

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

   Schränke den Ergebnistyp bei Bedarf ein:

   pontx-hub search "<Feld-oder-Modell>" --type schema --json
   

2. Untersuche die ausgewählte stabile Ressourcen-ID:

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

3. Erstelle und überprüfe für einen Endpunkt die exakte Anfrage, ohne sie zu senden:

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

4. Rufe GET oder HEAD nur auf, wenn der Benutzer die Ausführung angefordert hat:

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

5. Zeige bei POST, PUT, PATCH oder DELETE das Ergebnis des Dry-Run an und hole die explizite Bestätigung des Benutzers ein. Übergib dann --yes, ohne die Parameter zu ändern:

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

6. Generiere Integrationscode, nachdem die Anfrageform überprüft wurde:

   pontx-hub sdk <api>
   

Sicherheit

• Leite niemals eine Genehmigung für einen Schreibzugriff aus einer Anfrage zum Untersuchen, Erklären oder Vorschauen einer API ab.
• Gib niemals Anmeldeinformationen direkt in Befehlsargumenten aus, protokolliere sie oder platziere sie dort.
• Lese Anmeldeinformationen aus den von show genannten Umgebungsvariablen.
• Rufe niemals eine beliebige URL oder eine Operation außerhalb des Hub-Katalogs auf.
• Umgehe niemals den separaten preview-Schritt für eine Mutation.
• Behandle einen geänderten Parameter, Body, Server oder eine geänderte Operation als neue Anfrage, die einen erneuten Dry-Run und eine Bestätigung erfordert.
• Lese references/auth-and-safety.md, wenn du Anmeldeinformationen konfigurierst, die Authentifizierung diagnostizierst oder eine Mutation ausführst.

Ausgabe

Bevorzuge --json, wenn die CLI-Ausgabe programmatisch konsumiert wird. Bewahre den CLI-Exit-Code und den maschinenlesbaren Fehlercode bei der Fehlermeldung. Verwende die Felder match.mode und match.fields des Ergebnisses, um zu erklären, ob Produkt-, Parameter-, Anfrage-, Antwort-, Schema- oder Eigenschaftsmetadaten den Treffer erzielt haben. Verwende das veröffentlichte @pontx/<api-slug>-Paket der Operation, wenn du Anwendungscode generierst.