Cette page a été traduite par l'API Cloud Translation.

Installer SmartDocs

SmartDocs est installé automatiquement lorsque vous installez et exécutez les scripts de test d'installation décrits dans Tester l'installation. Lors de l'exécution des scripts de test, vous exécutez les commandes suivantes:

/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile

Où configFile est le même fichier de configuration que celui utilisé pour installer Edge. Pour en savoir plus, consultez Installer des composants Edge sur un nœud.

Cette commande installe SmartDocs lors de l'exécution des tests.

Pour terminer l'installation:

Vérifiez que SmartDocs est installé en vérifiant que le fichier smartdocs.zip se trouve dans le répertoire suivant:
```
/opt/apigee/apigee-validate/bundles/
```
Vous pouvez également exécuter l'appel d'API suivant sur le nœud du serveur de gestion:
```
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
```
Cette commande doit renvoyer le résultat suivant si SmartDocs est installé:
```
[ "smartdocs", "passthrough" ]
```
Dans l'interface utilisateur Edge, créez et mettez à jour un KVM nommé "smartdocs_Whitelist", comme illustré ci-dessous. La KVM doit être créée dans l'organisation et l'environnement dans lesquels le proxy SmartDocs est actuellement déployé.
Remarque: Assurez-vous que la case Chiffré n'est PAS cochée.
- Ajoutez une clé nommée "is_Whitelist_configure" dont la valeur est "YES".
- Ajoutez une deuxième clé nommée "allowed_hosts", où les valeurs sont des noms d'hôte séparés par un espace ou des adresses IP appelées à partir de SmartDocs. La valeur "allowed_hosts" doit inclure tous les hôtes inclus dans les spécifications OpenAPI ajoutés à SmartDocs. Par exemple, si vous disposez d'une spécification OpenAPI qui appelle mocktarget.apigee.net, vous devez ajouter mocktarget.apigee.net à la valeur "allowed_hosts". Si un hôte n'est pas inclus dans la KVM, la réponse de SmartDocs sera 400 Bad Request avec une charge utile de contenu de Bad Request-Hostname not permitted.
Remarque: Si vous n'ajoutez pas et ne configurez pas cette KVM, le proxy n'appliquera pas la liste blanche. Cela peut entraîner un accès non autorisé à vos hôtes et à vos adresses IP. Seuls les noms d'hôte et les adresses IP des points de terminaison de l'API documentés avec SmartDocs doivent être inclus dans les valeurs "allowed_hosts".