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. Lors de l'exécution du 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

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

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

Pour terminer l'installation:

  1. Vérifiez que SmartDocs est installé en vérifiant que le fichier smartdocs.zip est situé 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" ]
  2. À partir de l'interface utilisateur Edge, créez et mettez à jour une KVM nommée "smartdocs_membership", 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 encrypted 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", où les valeurs sont des noms d'hôte ou des adresses IP séparés par des espaces. appelé à 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 une spécification OpenAPI appelle mocktarget.apigee.net, vous devez ajouter mocktarget.apigee.net à "allowed_hosts" . Si un hôte n'est pas incluse dans la KVM, la réponse SmartDocs est 400 Bad Request avec un contenu la charge utile de Bad Request-Hostname not permitted.
    Interface de création de KVM Remarque: Si vous n'ajoutez pas et ne configurez pas ce KVM, le proxy n'appliquera pas la liste blanche. Ce pourrait entraîner un accès non autorisé à vos hôtes et 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.