SmartDocs viene installato automaticamente quando installi ed esegui gli script per il test di installazione descritto in Testare l'installazione. Nell'ambito dell'esecuzione degli script di test, esegui i seguenti comandi:
/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile
dove configFile è lo stesso file di configurazione 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 SmartDocumenti 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:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
Se è installato SmartDocs, questo comando dovrebbe restituire quanto segue:
[ "smartdocs", "passthrough" ]
- Dall'interfaccia utente di Edge, crea e aggiorna un KVM denominato "smartdocs_whitelist", come mostrato nella figura seguente.
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 Encrypted (Con crittografia) 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 aggiungeremocktarget.apigee.net
a "allowed_hosts" valore. Se un host non è incluso nel KVM, la risposta di SmartDocs sarà400 Bad Request
con un payload dei contenuti diBad Request-Hostname not permitted
.