Affichage de l'API REST à l'aide de Swagger dans les versions antérieures à la version 9.1.6

Si vous utilisez une version antérieure à la version 9.1.6, vous pouvez accéder à l'interface utilisateur Swagger pour afficher et tester toutes les API RESTful annotées avec les annotations prises en charge.

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 nœuds 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#/
    - http://localhost:6643/approvals/v3/api-docs
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.

Avant de commencer

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 sur l'affichage des API REST à partir de la version 9.1.6, voir HCL Commerce API REST.

Procédure

Démarrez les serveurs.
- Démarrez HCL Commerce Test Server, le serveur de test de personnalisation, le serveur de test de recherche et le serveur de test de magasin via la vue des serveurs HCL Commerce Developer.
- Démarrez les conteneurs Docker du serveur de transactions, du serveur de personnalisation, du serveur de recherche et du serveur de magasin.
Connectez-vous à votre magasin type en tant qu'administrateur de site.

Remarque : La connexion au magasin définit les jetons de sécurité afin que vous puissiez effectuer des appels REST à partir de Swagger. Bien que vous puissiez toujours afficher les ressources REST dans Swagger, le fait de ne pas vous connecter au magasin avec les autorisations appropriées vous empêche d'exécuter tout appel REST depuis Swagger.
Accédez à la spécification Swagger à l'aide d'un navigateur Web.
- Pour l'API REST de vitrine HCL Commerce : https://hostname:5443/wcs/resources/api
- Pour l'API REST de solutions de recherche basée sur Solr : https://hostname:3738/search/resources/swagger
- Pour la solution de recherche basée sur Elasticsearch
  - API REST Query : https://commerceHost:30901/search/resources/swagger
  - API REST Data Query : https://searchHost:30921/search/resources/swagger
  - API REST Ingest : https://searchHost:30801/swagger
- Pour les API REST xC du serveur de personnalisation : https://hostname:9443/commerceue/swagger/index.html.
  Les API REST xC s'affichent automatiquement. Si vous ne voyez pas d'API alors, dans la zone Explorer, entrez l'URL suivante https://hostname:9443/commerceue/extension/swagger.
Notes :
- Par défaut, la page Web de l'interface utilisateur Swagger charge l'URL des API REST HCL Commerce. Une fois que vous avez mis à jour la zone Explorer, cliquez sur le bouton Explorer pour éviter de déclencher une actualisation de page.
- Lorsque vous testez vos appels REST à l'aide de Swagger, sélectionnez l'ID storeId qui correspond au magasin auquel vous vous êtes connecté à l'étape 2.
- Lorsque vous accédez à la page Interface utilisateur Swagger, le même protocole (HTTPS) doit être utilisé pour l'URL de l'API REST dans la zone Explorer, ou vous rencontrerez des erreurs de partage de ressources d'origine croisée (CORS).
Si vous souhaitez examiner directement les fichiers .json de l'API REST, ils sont répertoriés ci-dessous.