SmartDocs, Yüklemeyi test etme bölümünde açıklanan yükleme testi komut dosyalarını yükleyip çalıştırdığınızda otomatik olarak yüklenir. Test komut dosyalarını çalıştırma kapsamında aşağıdaki komutları çalıştırırsınız:
/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFileconfigFile, Edge'i yüklemek için kullandığınız yapılandırma dosyasıdır. Daha fazla bilgi için Edge bileşenlerini bir düğüme yükleme başlıklı makaleyi inceleyin.
Bu komut, testleri çalıştırma kapsamında SmartDocs'u yükler.
Yüklemeyi tamamlamak için:
smartdocs.zipdosyasının aşağıdaki dizinde bulunduğunu onaylayarak SmartDocs'un yüklü olup olmadığını test edin:/opt/apigee/apigee-validate/bundles/
Alternatif olarak, yönetim sunucusu düğümünde aşağıdaki API çağrısını çalıştırın:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
SmartDocs yüklüyse bu komutun aşağıdaki sonucu döndürmesi gerekir:
[ "smartdocs", "passthrough" ]
- Edge kullanıcı arayüzünden, aşağıdaki resimde gösterildiği gibi "smartdocs_whitelist" adlı bir KVM oluşturun ve güncelleyin.
KVM, SmartDocs proxy'sinin şu anda dağıtıldığı kuruluşta ve ortamda oluşturulmalıdır.
Not: Şifrelenmiş kutusunun işaretli OLMADIĞINDAN emin olun.
- "is_whitelist_configured" adlı bir anahtar ekleyin ve değerini "YES" olarak ayarlayın.
- "allowed_hosts" adlı ikinci bir anahtar ekleyin. Bu anahtarın değerleri, SmartDocs'tan çağrılan, boşlukla ayrılmış ana makine adları veya IP adresleridir. "allowed_hosts" değeri, SmartDocs'a eklenen OpenAPI spesifikasyonlarına dahil edilen tüm ana makineleri içermelidir. Örneğin,
mocktarget.apigee.netadresini çağıran bir OpenAPI spesifikasyonunuz varsa "allowed_hosts" değerinemocktarget.apigee.netadresini eklemeniz gerekir. KVM'ye bir ana makine dahil edilmezse SmartDocs yanıtı400 Bad Requestolur ve içerik yüküBad Request-Hostname not permittedolur.
Not: Bu KVM'yi ekleyip yapılandırmazsanız proxy, izin verilenler listesini zorunlu kılmaz. Bu durum, ana makinelerinize ve IP adreslerinize yetkisiz erişime neden olabilir. "allowed_hosts" değerlerine yalnızca SmartDocs ile belgelenen API uç noktalarının ana makine adları ve IP adresleri eklenmelidir.