ระบบจะติดตั้ง SmartDocs โดยอัตโนมัติเมื่อคุณติดตั้งและเรียกใช้สคริปต์การทดสอบการติดตั้งที่อธิบายไว้ในทดสอบการติดตั้ง คุณจะเรียกใช้คําสั่งต่อไปนี้โดยเรียกใช้สคริปต์ทดสอบ
/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile
โดยที่ configFile คือไฟล์การกําหนดค่าเดียวกันกับที่คุณใช้ในการติดตั้ง Edge ดูติดตั้งคอมโพเนนต์ Edge ในโหนดสําหรับข้อมูลเพิ่มเติม
คําสั่งนี้จะติดตั้ง SmartDocs เป็นส่วนหนึ่งของการทดสอบ
วิธีดําเนินการติดตั้งให้เสร็จสมบูรณ์
ทดสอบว่ามีการติดตั้ง SmartDocs โดยการยืนยันว่าไฟล์
smartdocs.zipอยู่ในไดเรกทอรีต่อไปนี้/opt/apigee/apigee-validate/bundles/
หรือเรียกใช้การเรียก API ต่อไปนี้บนโหนดเซิร์ฟเวอร์การจัดการ:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
คําสั่งนี้ควรส่งคืนสิ่งต่อไปนี้ถ้ามีการติดตั้ง SmartDocs:
[ "smartdocs", "passthrough" ]
- จาก Edge UI ให้สร้างและอัปเดต KVM ที่ชื่อ "smartdocs_whitelist" ดังที่แสดงในรูปด้านล่าง
ควรสร้าง KVM ในองค์กรและสภาพแวดล้อมที่ใช้พร็อกซี SmartDocs อยู่
หมายเหตุ: ตรวจสอบว่าไม่ได้เลือกช่องเข้ารหัสไว้
- เพิ่มคีย์ชื่อ “is_whitelist_configured” โดยที่ค่าเป็น “YES”
- เพิ่มคีย์ที่ 2 ชื่อ “allowed_hosts” ซึ่งค่าจะเป็นชื่อโฮสต์หรือที่อยู่ IP ที่คั่นด้วยการเว้นวรรคซึ่งมาจาก SmartDocs ค่า "allowed_hosts" ควรรวมโฮสต์ที่รวมอยู่ในข้อกําหนดของ OpenAPI ที่เพิ่มลงใน SmartDocs ตัวอย่างเช่น หากคุณมีข้อกําหนด OpenAPI ที่เรียกใช้
mocktarget.apigee.netคุณจะต้องเพิ่มmocktarget.apigee.netไปยังค่า "allowed_hosts" หากโฮสต์ไม่ได้อยู่ใน KVM การตอบกลับของ SmartDocs จะเป็น400 Bad Requestที่มีเพย์โหลดเนื้อหาBad Request-Hostname not permitted
หมายเหตุ: หากไม่เพิ่มและกําหนดค่า KVM นี้ พร็อกซีจะไม่บังคับใช้รายการที่อนุญาตพิเศษ ซึ่งอาจทําให้เกิดการเข้าถึงที่ไม่ได้รับอนุญาตไปยังโฮสต์และที่อยู่ IP ของคุณ ค่า "allowed_hosts" ควรมีเฉพาะชื่อโฮสต์และที่อยู่ IP ของปลายทาง API ที่บันทึกไว้กับ SmartDocs เท่านั้น