Instal SmartDocs

SmartDocs diinstal secara otomatis saat Anda menginstal dan menjalankan skrip pengujian penginstalan yang dijelaskan dalam Menguji penginstalan. Sebagai bagian dari menjalankan pengujian skrip, 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 informasi selengkapnya.

Perintah ini menginstal SmartDocs sebagai bagian dari menjalankan pengujian.

Untuk menyelesaikan penginstalan:

  1. Uji apakah SmartDocs telah diinstal dengan mengonfirmasi bahwa file smartdocs.zip telah diinstal yang berada 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 hal berikut jika SmartDocs diinstal:

    [ "smartdocs", "passthrough" ]
  2. Dari UI Edge, buat dan update KVM bernama “smartdocs_whitelist”, seperti yang ditunjukkan pada gambar di bawah. KVM harus dibuat di organisasi dan lingkungan tempat proxy SmartDocs yang saat ini di-deploy.

    Catatan: Pastikan kotak untuk encrypted TIDAK dicentang.

    • Tambahkan kunci bernama “is_whitelist_flow”, dengan nilainya adalah “YES”.
    • Tambahkan kunci kedua bernama “allow_hosts”, dengan nilainya adalah alamat IP atau nama host yang dipisahkan spasi yang dipanggil dari SmartDocs. Nilai "allow_hosts" harus menyertakan host apa pun yang termasuk dalam spesifikasi OpenAPI ditambahkan ke SmartDocs. Misalnya, jika Anda memiliki spesifikasi OpenAPI yang memanggil mocktarget.apigee.net, Anda harus menambahkan mocktarget.apigee.net ke "Allow_hosts" dengan sejumlah nilai. Jika host tidak yang disertakan dalam KVM, respons SmartDocs akan menjadi 400 Bad Request dengan payload Bad Request-Hostname not permitted.
    Antarmuka pembuatan KVM Catatan: Jika Anda tidak menambahkan dan mengonfigurasi KVM ini, proxy tidak akan menerapkan daftar yang diizinkan. Ini dapat menyebabkan akses tidak berizin ke {i>host<i} dan alamat IP Anda. Hanya nama {i>host<i} dan alamat IP Endpoint API yang didokumentasikan dengan SmartDocs harus disertakan dalam "Allow_hosts" masing-masing.