SmartDocs diinstal secara otomatis saat Anda menginstal dan menjalankan skrip pengujian penginstalan yang dijelaskan dalam Menguji penginstalan. Sebagai bagian dari menjalankan skrip pengujian, Anda menjalankan perintah berikut:
/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile
Dengan 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 untuk memastikan bahwa SmartDocs diinstal dengan mengonfirmasi bahwa file
smartdocs.zip
berada di direktori berikut:/opt/apigee/apigee-validate/bundles/
Atau jalankan panggilan API berikut di node Server Manajemen:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
Perintah ini akan menampilkan hal berikut jika SmartDocs diinstal:
[ "smartdocs", "passthrough" ]
- Dari UI Edge, buat dan perbarui KVM bernama “smartdocs_permissions”, 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 dengan nama “is_permissions_configuration”, dengan nilai “YES”.
- Tambahkan kunci kedua bernama “allowed_hosts”, yang nilainya adalah 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.net
ke nilai "allowed_hosts". Jika host tidak disertakan dalam KVM, respons SmartDocs akan menjadi400 Bad Request
dengan payload kontenBad Request-Hostname not permitted
.