ระบบจะติดตั้ง SmartDocuments โดยอัตโนมัติเมื่อคุณติดตั้งและเรียกใช้สคริปต์การทดสอบการติดตั้ง ตามที่อธิบายไว้ในหัวข้อทดสอบการติดตั้ง ในการเรียกใช้สคริปต์ทดสอบ คุณจะต้องเรียกใช้คำสั่งต่อไปนี้
/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
คำสั่งนี้จะแสดงผลค่าต่อไปนี้หากติดตั้ง SmartDocuments ไว้
[ "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 ที่จัดทำด้วย SmartDocuments ควรรวมอยู่ใน "allowed_hosts"