Diese Seite wurde von der Cloud Translation API übersetzt.

SmartDocs installieren

SmartDocs wird automatisch installiert, wenn Sie die Testskripts für die Installation installieren und ausführen wie unter Installation testen beschrieben. Im Rahmen des Tests führen Sie 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 dieselbe 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:

Testen Sie, ob SmartDocs installiert ist, indem Sie prüfen, ob die Datei smartdocs.zip im folgenden Verzeichnis:
```
/opt/apigee/apigee-validate/bundles/
```
Oder führen Sie den folgenden API-Aufruf auf dem Knoten des Verwaltungsservers aus:
```
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
```
Dieser Befehl sollte Folgendes zurückgeben, wenn SmartDocs installiert ist:
```
[ "smartdocs", "passthrough" ]
```
Erstellen und aktualisieren Sie in der Edge-Benutzeroberfläche eine KVM mit dem Namen "smartdocs_whitelist", wie in der folgenden Abbildung dargestellt. Die KVM sollte in der Organisation und Umgebung erstellt werden, in der sich der SmartDocs-Proxy befindet aktuell bereitgestellt wird.
Hinweis: Achten Sie darauf, dass das Kästchen für verschlüsselt NICHT angeklickt ist.
- Fügen Sie einen Schlüssel mit dem Namen „is_whitelist_configure“ hinzu, wobei der Wert „YES“ ist.
- Fügen Sie einen zweiten Schlüssel namens „allowed_hosts“ hinzu, wobei die Werte durch Leerzeichen voneinander getrennte Hostnamen oder IP-Adressen sind. von SmartDocs aufgerufen. Der Wert von „allowed_hosts“ sollte alle Hosts enthalten, die in den OpenAPI-Spezifikationen enthalten sind zu SmartDocs hinzugefügt. Wenn Sie beispielsweise eine OpenAPI-Spezifikation haben, die mocktarget.apigee.net aufruft, Sie müssen mocktarget.apigee.net zu „allowed_hosts“ hinzufügen Wert. Wenn ein Host nicht in der KVM enthalten ist, lautet die SmartDocs-Antwort 400 Bad Request mit einem Inhalt Nutzlast von Bad Request-Hostname not permitted.
Hinweis: Wenn Sie diese KVM nicht hinzufügen und konfigurieren, erzwingt der Proxy keine Zulassungsliste. Dieses zu unberechtigten Zugriff auf Ihre Hosts und IP-Adressen führen. Nur Hostnamen und IP-Adressen von Mit SmartDocs dokumentierte API-Endpunkte sollten in „allowed_hosts“ enthalten sein Werte.