Interface utilisateur swagger

Une version en direct de l'API REST HCL Commerce est disponible dans un navigateur Web sur votre HCL Commerce Test Server à l'aide de l'interface utilisateur Swagger. Elle est composée d'un ensemble de code HTML, CSS et JavaScript statique qui documente dynamiquement l'API REST disponible sur HCL Commerce Test Server.

Remarque :

A partir de la version 9.1.6, l'interface utilisateur Swagger n'est pas fournie avec les API REST de HCL Commerce. Pour afficher les API REST à l'aide de l'interface utilisateur Swagger, utilisez l'éditeur Swagger.

Pour plus d'informations, voir API REST.

Important :
  • Pour des raisons de sécurité, Swagger ne doit pas être exposé dans votre environnement de production opérationnel.

    Vous pouvez l'empêcher d'être exposé comme suit :

    • Si les ports de l'API REST ne doivent pas être exposés en externe, assurez-vous qu'ils sont bloqués par vos règles de pare-feu. Ces ports incluent 5443, 3738, 9443, 30901, 30921, et 30801.
    • Si vous devez exposer ces ports :
      1. Désactivez l'API Discovery REST pour le Transaction server. Pour plus d'informations, voir Activation et désactivation de l'API Discovery REST.
      2. Assurez-vous de configurer votre serveur Web de façon à bloquer l'accès aux noeuds finaux swagger suivants :
        • https://commerceHostname:3738/search/resources/swagger
        • https://commerceHostname:9443/commerceue/extension/swagger
        • https://commerceHostname:30901/search/resources/swagger
        • https://searchHost:30921/search/resources/swagger
        • https://searchHost:30801/swagger-ui.html#/
  • L'interface utilisateur Swagger est fournie en l'état. Elle contient l'API REST HCL Commerce ainsi que d'autres informations relatives au système de backend Swagger. La personnalisation de l'interface utilisateur Swagger, par exemple pour afficher des gestionnaires de ressources personnalisés, des annotations ou des données supplémentaires, n'est pas prise en charge.

La capture d'écran suivante montre la page d'accueil de l'interface utilisateur Swagger :
capture d'écran de l'interface utilisateur Swagger
Où :
  • Chaque classe de gestionnaire de ressources s'affiche avec une courte description du service.
  • Afficher/Masquer étend ou réduit le contenu de l'API de chaque classe.
  • Répertorier les opérations affiche une vue récapitulative du contenu de l'API, où une ligne s'affiche pour le chemin d'accès de chaque méthode, avec une courte description du service.
  • Développer les opérations affiche une vue étendue du contenu de l'API, où les lignes s'affichent pour la classe de réponse, les paramètres et les codes de statut de chaque méthode. L'API peut être testée dynamiquement en sélectionnant Essayez-le ! dans la vue étendue.
  • Brut affiche les informations brutes que l'interface utilisateur Swagger utilise pour remplir la page.