SmartDocs installieren

SmartDocs wird automatisch installiert, wenn Sie die unter Installation testen beschriebenen Installationstestskripts installieren und ausführen. Führen Sie zum Ausführen der Testskripts die folgenden Befehle aus:

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

Dabei ist configFile die Konfigurationsdatei, die Sie zum Installieren von Edge verwendet haben. Weitere Informationen finden Sie unter Edge-Komponenten auf einem Knoten installieren.

Mit diesem Befehl wird SmartDocs im Rahmen der Tests installiert.

So schließen Sie die Installation ab:

  1. Testen Sie, ob SmartDocs installiert ist. Prüfen Sie dazu, ob sich die Datei smartdocs.zip im folgenden Verzeichnis befindet:

    /opt/apigee/apigee-validate/bundles/

    Sie können auch den folgenden API-Aufruf auf dem Verwaltungsserverknoten ausführen:

    curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis

    Wenn SmartDocs installiert ist, sollte dieser Befehl Folgendes zurückgeben:

    [ "smartdocs", "passthrough" ]
  2. Erstellen und aktualisieren Sie in der Edge-Benutzeroberfläche eine KVM mit dem Namen „smartdocs_Whitelist“ (siehe Abbildung unten). Die KVM sollte in der Organisation und Umgebung erstellt werden, in der der SmartDocs-Proxy derzeit bereitgestellt ist.

    Hinweis: Das Kästchen für verschlüsselt darf NICHT angeklickt sein.

    • Fügen Sie einen Schlüssel namens „is_Whitelist_configure“ hinzu, wobei der Wert „JA“ ist.
    • Fügen Sie einen zweiten Schlüssel namens „allowed_hosts“ hinzu. Die Werte sind durch Leerzeichen getrennte Hostnamen oder IP-Adressen, die von SmartDocs aufgerufen werden. Der Wert von „allowed_hosts“ sollte alle Hosts enthalten, die in den OpenAPI-Spezifikationen enthalten sind, die SmartDocs hinzugefügt werden. Wenn Sie beispielsweise eine OpenAPI-Spezifikation haben, die mocktarget.apigee.net aufruft, müssen Sie mocktarget.apigee.net zum Wert „allowed_hosts“ hinzufügen. Wenn ein Host nicht in der KVM enthalten ist, lautet die SmartDocs-Antwort 400 Bad Request mit der Inhaltsnutzlast Bad Request-Hostname not permitted.
    KVM-Erstellungsoberfläche Hinweis: Wenn Sie diese KVM nicht hinzufügen und konfigurieren, erzwingt der Proxy keine Zulassungsliste. Dies kann zu einem nicht autorisierten Zugriff auf Ihre Hosts und IP-Adressen führen. Nur die Hostnamen und IP-Adressen von mit SmartDocs dokumentierten API-Endpunkten sollten in den Werten für „allowed_hosts“ enthalten sein.