ระบบจะติดตั้ง 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
คำสั่งนี้จะแสดงผลค่าต่อไปนี้หากติดตั้ง Smartdocs ไว้
[ "smartdocs", "passthrough" ]
- จาก Edge UI ให้สร้างและอัปเดต KVM ที่ชื่อว่า "smartdocs_Whitelist" ดังที่แสดงในรูปด้านล่าง
ควรสร้าง KVM ในองค์กรและสภาพแวดล้อมที่พร็อกซี SmartDocument
ที่ทำให้ใช้งานได้อยู่ในขณะนี้
หมายเหตุ: ตรวจสอบว่าไม่ได้เลือกช่องเข้ารหัสไว้
- เพิ่มคีย์ชื่อ "is_whitelist_Configure" โดยที่ค่าคือ "YES"
- เพิ่มคีย์ที่สองชื่อ "allowed_hosts" โดยที่ค่าคือชื่อโฮสต์หรือที่อยู่ IP ที่คั่นด้วยช่องว่าง
ที่เรียกจาก SmartDocuments ค่าของ "allowed_hosts" ควรรวมโฮสต์ใดๆ ที่รวมอยู่ในข้อกำหนดของ OpenAPI
เพิ่มลงใน SmartDocuments แล้ว ตัวอย่างเช่น หากคุณมีข้อกำหนดของ 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"