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écrit dans la section Tester l'installation. Pour exécuter les scripts de test, 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 confirmant 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
```
Si SmartDocs est installé, cette commande doit renvoyer le résultat suivant:
```
[ "smartdocs", "passthrough" ]
```
À partir de l'interface utilisateur Edge, créez et mettez à jour une KVM nommée "smartdocs_whitepaper", comme illustré dans la figure ci-dessous. La KVM doit être créée dans l'organisation et l'environnement dans lesquels le proxy SmartDocs est actuellement déployées.
Remarque : Assurez-vous que la case chiffré n'est PAS cochée.
- Ajoutez une clé nommée "is_Dans_liste_configuré", avec la valeur "OUI".
- Ajoutez une deuxième clé nommée "allowed_hosts", dont les valeurs sont des noms d'hôtes ou des adresses IP séparés par des espaces appelés à partir de SmartDocs. La valeur de "allowed_hosts" doit inclure tous les hôtes inclus dans les spécifications OpenAPI ajoutés aux SmartDocs. Par exemple, si vous disposez d'une spécification OpenAPI qui appelle mocktarget.apigee.net, vous devrez ajouter mocktarget.apigee.net à la valeur "allowed_hosts". Si un hôte n'est pas inclus dans le KVM, la réponse SmartDocs est 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 ce 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 de Les points de terminaison de l'API documentés avec SmartDocs doivent être inclus dans la liste "allowed_hosts". valeurs.