SmartDocs viene installato automaticamente quando installi ed esegui gli script di test dell'installazione descritti in Testa 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 configFileDove configFile è lo stesso file di configurazione utilizzato per installare Edge. Per saperne di più, consulta Installa i componenti Edge su un nodo.
Questo comando installa SmartDocs nell'ambito dell'esecuzione dei test.
Per completare l'installazione:
Verifica che SmartDocs sia installato confermando che il file
smartdocs.zipsi trova nella seguente directory:/opt/apigee/apigee-validate/bundles/
In alternativa, esegui la seguente chiamata API sul nodo del server di gestione:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
Se SmartDocs è installato, questo comando dovrebbe restituire quanto segue:
[ "smartdocs", "passthrough" ]
- Dalla UI 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 è attualmente eseguito il deployment del proxy SmartDocs.
Nota: assicurati che la casella encrypted (criptato) NON sia selezionata.
- Aggiungi una chiave denominata "is_whitelist_configured", con il valore "YES".
- Aggiungi una seconda chiave denominata "allowed_hosts", dove i valori sono nomi host o indirizzi IP separati da spazi chiamati da SmartDocs. Il valore di "allowed_hosts" deve includere tutti gli host inclusi nelle specifiche OpenAPI aggiunte a SmartDocs. Ad esempio, se hai una specifica OpenAPI che chiama
mocktarget.apigee.net, dovrai aggiungeremocktarget.apigee.netal valore "allowed_hosts". Se un host non è incluso nel KVM, la risposta di SmartDocs sarà400 Bad Requestcon un payload dei contenuti diBad Request-Hostname not permitted.
Nota: se non aggiungi e configuri questa KVM, il proxy non applicherà la lista consentita. Ciò potrebbe comportare un accesso non autorizzato ai tuoi host e indirizzi IP. Solo i nomi host e gli indirizzi IP degli endpoint API documentati con SmartDocs devono essere inclusi nei valori "allowed_hosts".