API afficher

Affiche des informations sur les points de terminaison de l’API REST du proxy de développement.

Synopsis

devproxy api show [options]

Options:
  --output <format>   Output format: text|json (default: text)
  -h, --help          Show help

Usage

devproxy api show

Options

Nom	Descriptif	Valeurs autorisées	Par défaut
--output <format>	Format de sortie	text, json	text
-?, -h, --help	Afficher les informations d’aide et d’utilisation	n/a	n/a

Exemples

Afficher les informations sur l’API du proxy de développement

devproxy api show

Obtenir des informations sur l’API en tant que JSON

devproxy api show --output json

Remarques

Le proxy de développement expose une API REST authentifiée à l’adresse http://{api-ip-address}:{api-port} (par défaut http://127.0.0.1:8897). Tous les points de terminaison nécessitent le jeton du porteur d’instance dans l’en-tête de Authorization requête. Pour récupérer le jeton, utilisez la commande de jeton d’API .

La api show commande répertorie l’URL de base de l’API, les exigences d’authentification et les points de terminaison d’API REST disponibles. Avec --output json, il inclut également le modèle de fichier de jeton. L’URL de base reflète l’adresse et le port d’API configurés. Pour obtenir l’URL d’API réelle d’une instance en cours d’exécution, par exemple lorsque vous utilisez --api-port 0, utilisez la commande d’état . L’API est disponible pendant l’exécution du proxy de développement. Utilisez l’interface CLI pour les opérations de cycle de vie (démarrer, arrêter, configurer) et utilisez l’API REST pour les opérations d’exécution (état proxy, enregistrement, gestion fictif).

Les points de terminaison suivants sont disponibles :

Méthode	Point de terminaison	Descriptif
GET	/proxy	Obtenir l’état du proxy
POST	/proxy	Mettre à jour l’état du proxy (par exemple, démarrer ou arrêter l’enregistrement)
POST	/proxy/mockRequest	Envoyer une demande fictive
POST	/proxy/stopProxy	Arrêter le proxy
POST	/proxy/jwtToken	Créer un jeton web JSON (JWT)
GET	/proxy/rootCertificate	Obtenir le certificat racine
GET	/proxy/logs	Obtenir les journaux du proxy de développement (mode détaché uniquement)

Pour obtenir la référence complète de l’API, consultez l’API proxy.