ระบบจะติดตั้ง 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 ของคุณโดยไม่ได้รับอนุญาต เฉพาะชื่อโฮสต์และที่อยู่ IP ของปลายทาง API ที่บันทึกไว้ด้วย SmartDocs เท่านั้นที่ควรอยู่ในค่า "allowed_hosts"