SmartDocs diinstal secara otomatis saat Anda menginstal dan menjalankan skrip pengujian penginstalan yang dijelaskan dalam Menguji penginstalan. Sebagai bagian dari menjalankan skrip pengujian, jalankan perintah berikut:
/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFileDengan configFile adalah file konfigurasi yang sama dengan yang Anda gunakan untuk menginstal Edge. Lihat Menginstal komponen Edge pada node untuk mengetahui informasi selengkapnya.
Perintah ini menginstal SmartDocs sebagai bagian dari menjalankan pengujian.
Untuk menyelesaikan penginstalan:
Uji apakah SmartDocs telah diinstal dengan mengonfirmasi bahwa file
smartdocs.zipberada di direktori berikut:/opt/apigee/apigee-validate/bundles/
Atau jalankan panggilan API berikut pada node Server Pengelolaan:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
Perintah ini akan menampilkan hasil berikut jika SmartDocs diinstal:
[ "smartdocs", "passthrough" ]
- Dari UI Edge, buat dan perbarui KVM bernama “smartdocs_whitelist”, seperti yang ditunjukkan pada gambar di bawah.
KVM harus dibuat di organisasi dan lingkungan tempat proxy SmartDocs saat ini di-deploy.
Catatan: Pastikan kotak untuk encrypted TIDAK dicentang.
- Tambahkan kunci bernama “is_whitelist_configured”, dengan nilai “YES”.
- Tambahkan kunci kedua bernama “allowed_hosts”, dengan nilai berupa nama host atau alamat IP yang dipisahkan spasi
yang dipanggil dari SmartDocs. Nilai "allowed_hosts" harus menyertakan host apa pun yang disertakan dalam spesifikasi OpenAPI yang ditambahkan ke SmartDocs. Misalnya, jika Anda memiliki spesifikasi OpenAPI yang memanggil
mocktarget.apigee.net, Anda harus menambahkanmocktarget.apigee.netke nilai "allowed_hosts". Jika host tidak disertakan dalam KVM, respons SmartDocs akan berupa400 Bad Requestdengan payload kontenBad Request-Hostname not permitted.
Catatan: Jika Anda tidak menambahkan dan mengonfigurasi KVM ini, proxy tidak akan menerapkan daftar yang diizinkan. Hal ini dapat mengakibatkan akses yang tidak sah ke host dan alamat IP Anda. Hanya nama host dan alamat IP endpoint API yang didokumentasikan dengan SmartDocs yang boleh disertakan dalam nilai "allowed_hosts".