Amélioration de la fonctionnalité d'API DX NetOps Spectrum REST (Swagger)

À partir de la version 10.4.1, vous pouvez accéder à la documentation de l'API de
DX NetOps Spectrum
à l'aide de Swagger. L'interface utilisateur de Swagger vous permet de visualiser et d'interagir avec l'API REST de
DX NetOps Spectrum
en fournissant une documentation visuelle.
Vous disposez maintenant de la documentation et des terminaux Swagger pour utiliser les services Web RESTful de
DX NetOps Spectrum
. Les terminaux de l'API REST sont fournis dans un cadre d'auto-documentation qui vous permet de tester les méthodes et d'afficher les réponses générées. Toutes les méthodes sont regroupées par type de ressource et peuvent être affichées dans une fenêtre unique. Utilisez les options
Show/Hide
(Afficher/Masquer),
List Operations
(Répertorier les opérations) et
Expand Operations
(Développer les opérations) pour développer et réduire les ressources et les méthodes.
Les méthodes sont codées par couleur pour faciliter la distinction entre les différentes méthodes. A droite de chaque méthode figure une brève description de l'action effectuée par la méthode. La documentation est fournie pour les paramètres de demande. Un exemple de schéma de modèle est disponible pour les méthodes nécessitant une charge utile dans la demande. Utilisez le schéma de modèle fourni pour remplir le champ Body (Corps), puis remplacez les valeurs par défaut par les paramètres souhaités. Utilisez le bouton
Try it out!
Bouton pour envoyer la demande et afficher la réponse générée en temps réel.
La section
Response Messages
(Messages de réponse) pour chaque méthode fournit une liste de codes de réponse documentée. Utilisez ces informations pour vous aider à définir une action corrective si une condition d'erreur a été rencontrée. La réponse renvoyée pour chaque demande s'affiche dans la fenêtre déroulante Method (Méthode).
Accès à la documentation de l'API
Cliquez sur le lien du menu
API Documentation
(Documentation de l'API) dans l'interface Web OneClick pour accéder à l'API REST.
La capture d'écran suivante affiche l'interface Swagger. Cette interface affiche quelques-uns des services Web RESTful fournis par
DX NetOps Spectrum
 :
Swagger for REST API Documentation
Pour plus d'informations sur l'utilisation de Swagger pour l'API REST, consulter la documentation relative à Swagger.