Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

Installer SmartDocs

SmartDocs est installé automatiquement lorsque vous installez et exécutez les scripts de test d'installation décrits dans Tester l'installation. Pour exécuter les scripts de test, vous devez exécuter 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 que vous avez utilisé pour installer Edge. Pour en savoir plus, consultez Installer des composants Edge sur un nœud.

Cette commande installe SmartDocs dans le cadre 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
```
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é dans la figure ci-dessous. Le KVM doit être créé 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_configured" avec la valeur "YES".
- Ajoutez une deuxième clé nommée "allowed_hosts", dont les valeurs sont des noms d'hôte ou des adresses IP séparés par des espaces, appelés depuis SmartDocs. La valeur de "allowed_hosts" doit inclure tous les hôtes inclus dans les spécifications OpenAPI ajoutées à 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 le KVM, la réponse 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 ce KVM, le proxy n'appliquera pas la liste d'autorisation. Cela pourrait 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 d'API documentés avec SmartDocs doivent être inclus dans les valeurs "allowed_hosts".