Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

SmartDocs installieren

SmartDocs wird automatisch installiert, wenn Sie die unter Installation testen beschriebenen Installations-Testskripts installieren und ausführen. Führen Sie im Rahmen 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 dieselbe Konfigurationsdatei, die Sie für die Installation 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:

Prüfen Sie, ob SmartDocs installiert ist. Dazu muss sich die Datei smartdocs.zip im folgenden Verzeichnis befinden:
```
/opt/apigee/apigee-validate/bundles/
```
Alternativ können Sie den folgenden API-Aufruf auf dem Management Server-Knoten ausführen:
```
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 Abbildung unten dargestellt. 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 aktiviert sein.
- Fügen Sie einen Schlüssel mit dem Namen „is_whitelist_configured“ hinzu, wobei der Wert „YES“ ist.
- Fügen Sie einen zweiten Schlüssel mit dem Namen „allowed_hosts“ hinzu, wobei die Werte durch Leerzeichen getrennte Hostnamen oder IP-Adressen sind, die von SmartDocs aufgerufen werden. Der Wert von „allowed_hosts“ sollte alle Hosts enthalten, die in OpenAPI-Spezifikationen enthalten sind, die SmartDocs hinzugefügt wurden. Wenn Sie beispielsweise eine OpenAPI-Spezifikation haben, die mocktarget.apigee.net aufruft, müssen Sie mocktarget.apigee.net dem Wert „allowed_hosts“ hinzufügen. Wenn ein Host nicht in der KVM enthalten ist, lautet die SmartDocs-Antwort 400 Bad Request mit einer Inhaltsnutzlast von Bad Request-Hostname not permitted.
Hinweis: Wenn Sie diese KVM nicht hinzufügen und konfigurieren, wird die Zulassungsliste vom Proxy nicht erzwungen. Dies könnte zu unbefugtem Zugriff auf Ihre Hosts und IP-Adressen führen. In den „allowed_hosts“-Werten sollten nur Hostnamen und IP-Adressen von API-Endpunkten enthalten sein, die mit SmartDocs dokumentiert sind.