SmartDocs viene installato automaticamente quando installi ed esegui gli script per il test di installazione
descritto in Testare l'installazione. Nell'ambito dell'esecuzione del test
script, esegui questi comandi:
Dove configFile è lo stesso file di configurazione che hai utilizzato per installare Edge.
Per ulteriori informazioni, consulta Installare i componenti Edge su un nodo.
Questo comando installa SmartDocs durante l'esecuzione dei test.
Per completare l'installazione:
Verifica l'installazione di SmartDocs confermando che il file smartdocs.zip è
situato nella seguente directory:
/opt/apigee/apigee-validate/bundles/
Oppure esegui la seguente chiamata API sul nodo del server di gestione:
Se è installato SmartDocs, il comando dovrebbe restituire quanto segue:
[ "smartdocs", "passthrough" ]
Dalla UI Edge, crea e aggiorna una KVM denominata "smartdocs_Whitelist", come mostrato nella figura di seguito.
La KVM deve essere creata nell'organizzazione e nell'ambiente in cui è installato il proxy SmartDocs
di cui è stato eseguito il deployment.
Nota: assicurati che la casella per il critto NON sia selezionata.
Aggiungi una chiave denominata "is_Whitelist_configuration", dove il valore è "YES".
Aggiungi una seconda chiave denominata "allowed_hosts", in cui i valori sono nomi host o indirizzi IP separati da spazi.
chiamato da SmartDocs. Il valore di "allowed_hosts" dovrebbe includere tutti gli host inclusi nelle specifiche OpenAPI
aggiunto a SmartDocs. Ad esempio, se disponi di una specifica OpenAPI che chiama mocktarget.apigee.net,
dovrai aggiungere mocktarget.apigee.net a "allowed_hosts" valore. Se un host non è
inclusa nella KVM, la risposta SmartDocs sarà 400 Bad Request con un contenuto
payload di Bad Request-Hostname not permitted.
di Gemini Advanced.
Nota: se non aggiungi e non configuri questa KVM, il proxy non applicherà l'autorizzazione. Questo
potrebbe causare un accesso non autorizzato a host e indirizzi IP. Solo i nomi host e gli indirizzi IP di
Gli endpoint API documentati con SmartDocs devono essere inclusi nel file "allowed_hosts" e i relativi valori.