Que fait pontx-hub-cli ?
CLI et client TypeScript pour la découverte d'API publiques Pontx, la recherche de points de terminaison et de schémas OpenAPI, les aperçus et l'intégration SDK
Installation
npm install -g @pontx/pontx-hub-cli
Ou utilisez-le directement avec npx :
npx @pontx/pontx-hub-cli --help
Utilisation
Rechercher des API
pontx-hub search <mot-clé>
Aperçu des détails d'une API
pontx-hub preview <id-api>
Obtenir un point de terminaison spécifique
pontx-hub endpoint <chemin-du-point-de-terminaison>
Intégration SDK
pontx-hub sdk <id-api> --lang typescript
Fonctionnalités
- Recherche : Recherchez des API publiques par mot-clé, tag ou catégorie.
- Aperçu : Affichez la documentation OpenAPI complète d'une API avant de l'intégrer.
- Points de terminaison : Obtenez des détails sur un point de terminaison spécifique, y compris les paramètres, les schémas de requête et de réponse.
- Schémas : Exportez les schémas OpenAPI au format JSON ou YAML.
- SDK : Générez un client SDK en TypeScript prêt à l'emploi.
Exemples
Recherche avancée
pontx-hub search "api météo" --tag météorologie
Obtenir un schéma
pontx-hub schema <id-api> --format yaml
API TypeScript (utilisation en programmation)
import { PontxHub } from '@pontx/pontx-hub-cli';
const hub = new PontxHub();
// Rechercher des API
const résultats = await hub.rechercher('api météo');
// Obtenir un aperçu
const aperçu = await hub.obtenirAperçu('id-api');
// Générer un SDK
const sdk = await hub.générerSDK('id-api', 'typescript');
Licence
MIT