คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่
เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล
ขั้นตอนที่แชร์เป็นฟังก์ชันที่นํามาใช้ใหม่ได้ซึ่งคล้ายกับพร็อกซี API เนื้อหาส่วนใหญ่ของ จะมีความคุ้นเคย หากคุณคุ้นเคยกับพร็อกซี API อยู่แล้ว
หากคุณกำลังเรียนรู้วิธีสร้างขั้นตอนที่แชร์ ให้เริ่มต้นด้วยหัวข้อขั้นตอนที่แชร์แบบใช้ซ้ำได้
โครงสร้างกลุ่มโฟลว์ที่แชร์
แพ็กเกจโฟลว์ที่แชร์ประกอบด้วยการกําหนดค่าต่อไปนี้
การกำหนดค่าพื้นฐาน | การตั้งค่าการกำหนดค่าหลัก โปรดดูการกำหนดค่าพื้นฐาน |
นโยบาย | ไฟล์การกำหนดค่ารูปแบบ XML ที่สอดคล้องกับสคีมานโยบาย Apigee Edge โปรดดู นโยบาย |
แหล่งข้อมูล | สคริปต์ ไฟล์ JAR และไฟล์ XSLT ที่อ้างอิงโดยนโยบายเพื่อดำเนินการตรรกะที่กำหนดเอง โปรดดู แหล่งข้อมูล |
SharedFlows | ขั้นตอนที่แชร์รวมอยู่ในแพ็กเกจนี้ ดูขั้นตอนที่แชร์ |
คอมโพเนนต์ในตารางด้านบนกำหนดโดยไฟล์การกำหนดค่าในข้อมูลต่อไปนี้ โครงสร้างไดเรกทอรี
ไฟล์การกำหนดค่าและโครงสร้างไดเรกทอรีของกลุ่มโฟลว์ที่แชร์
ส่วนนี้จะอธิบายถึงไฟล์การกำหนดค่าและโครงสร้างไดเรกทอรีของโฟลว์ที่แชร์
การกำหนดค่าพื้นฐาน
ไฟล์การกำหนดค่าพื้นฐานจะอยู่ที่ไดเรกทอรีรากของแพ็กเกจ ชื่อของกลุ่มนี้คือชื่อของ แพ็กเกจนั้น
/sharedflowbundle/traffic-management-shared.xml
การกำหนดค่าพื้นฐานจะกำหนดเนื้อหาของแพ็กเกจโฟลว์ที่แชร์ รวมถึงข้อมูล เพื่อติดตามประวัติการแก้ไขของแพ็กเกจ
<SharedFlowBundle revision="2" name="traffic-management-shared"> <ConfigurationVersion majorVersion="4" minorVersion="0"/> <CreatedAt>1478637529218</CreatedAt> <CreatedBy>gladys@example.com</CreatedBy> <Description>Shared flow to moderate API traffic</Description> <DisplayName>traffic-management-shared</DisplayName> <LastModifiedAt>1481573374023</LastModifiedAt> <LastModifiedBy>gladys@example.com</LastModifiedBy> <Policies> <Policy>Auth-Flow-Callout</Policy> <Policy>Extract-Token</Policy> <Policy>Spike-Arrest</Policy> </Policies> <Resources> <Resource>jsc://extract-token.js</Resource> </Resources> <SharedFlows> <SharedFlow>default</SharedFlow> </SharedFlows> </SharedFlowBundle>
แอตทริบิวต์การกำหนดค่าพื้นฐาน
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
SharedFlowBundle |
|||
name |
ชื่อกลุ่มโฟลว์ที่แชร์ ซึ่งต้องไม่ซ้ำกันภายในองค์กร
อักขระที่คุณได้รับอนุญาตให้ใช้ในชื่อจะถูกจำกัดดังต่อไปนี้:
A-Za-z0-9_- |
ไม่มี | ใช่ |
revision |
หมายเลขการแก้ไขของการกำหนดค่ากลุ่มโฟลว์ที่แชร์ คุณไม่จำเป็นต้อง กำหนดหมายเลขการแก้ไขอย่างชัดเจน เนื่องจาก Apigee Edge จะติดตามหมายเลขเวอร์ชันโดยอัตโนมัติ การแก้ไขของขั้นตอนที่แชร์ | ไม่มี | ไม่ได้ |
องค์ประกอบการกำหนดค่าฐาน
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
SharedFlowBundle |
|||
ConfigurationVersion |
เวอร์ชันของสคีมาการกำหนดค่ากลุ่มโฟลว์ที่แชร์ที่โฟลว์ที่แชร์นี้ใช้ สอดคล้อง ปัจจุบันค่าเดียวที่รองรับคือ mainVersion 4 และ customerVersion 0 ช่วงเวลานี้ ในอนาคตอาจนำการตั้งค่าออกเพื่อให้วิวัฒนาการของแพ็กเกจขั้นตอนที่แชร์ | 4.0 | ไม่ได้ |
CreatedAt และ CreatedBy |
วันที่/เวลา (เป็นเวลา Epoch) ที่สร้างกลุ่มขั้นตอนที่แชร์พร้อมกับ อีเมลของผู้ใช้ที่สร้าง | ||
Description |
คำอธิบายแบบข้อความของขั้นตอนที่แชร์ หากระบุไว้ คำอธิบายจะแสดงใน Edge Management UI | ไม่มี | ไม่ได้ |
DisplayName |
ชื่อที่ใช้ง่ายซึ่งอาจแตกต่างจากแอตทริบิวต์ name ของ
การกำหนดค่าโฟลว์ที่แชร์ |
ไม่มี | ไม่ได้ |
LastModifiedAt และ LastModifiedBy |
วันที่/เวลา (เป็นเวลา Epoch) ที่แก้ไขกลุ่มขั้นตอนที่แชร์ครั้งล่าสุด พร้อมทั้ง อีเมลของผู้ใช้ที่แก้ไข | ||
Policies |
รายการนโยบายในไดเรกทอรี /policies ของขั้นตอนที่แชร์นี้ คุณ
โดยปกติแล้วจะเห็นองค์ประกอบนี้เมื่อสร้างขั้นตอนที่แชร์โดยใช้ Edge เท่านั้น
UI ของการจัดการ นี่เป็นแค่ 'ไฟล์ Manifest' ที่ออกแบบมาเพื่อแสดงการเข้าชม
ของขั้นตอนที่แชร์ |
ไม่มี | ไม่ได้ |
Resources |
รายการทรัพยากร (JavaScript, Python, Java, ePub) ใน /resources
ของขั้นตอนที่แชร์นี้ โดยปกติคุณจะเห็นองค์ประกอบนี้เมื่อขั้นตอนที่แชร์
สร้างขึ้นโดยใช้ UI การจัดการ Edge นี่เป็นแค่ 'ไฟล์ Manifest' ที่ออกแบบมาเพื่อ
กำหนดระดับการเข้าถึงเนื้อหาของขั้นตอนที่แชร์ |
ไม่มี | ไม่ได้ |
SharedFlows |
ระบุขั้นตอนที่แชร์ที่มีอยู่ในแพ็กเกจนี้
โปรดทราบว่าในขณะนี้องค์ประกอบนี้รองรับ <SharedFlow> ระดับย่อยเพียง 1 รายการ รายการเดียว คุณเพิ่มขั้นตอนที่แชร์ลงในกลุ่มขั้นตอนที่แชร์ได้ |
ไม่มี | ใช่ |
ขั้นตอนที่แชร์
/sharedflowbundle/sharedflows/default.xml
การกำหนดค่า SharedFlow จะกำหนดลำดับที่ควรเรียกใช้เอลิเมนต์โฟลว์ <SharedFlow> <ขั้นตอน>ขององค์ประกอบ องค์ประกอบย่อยแต่ละอย่างจะระบุส่วนของลำดับ เช่น การเรียกนโยบาย
การกำหนดค่า SharedFlow ต่อไปนี้ระบุนโยบาย 3 รายการที่จะดำเนินการใน ลำดับจากบนลงล่าง (จากซ้ายไปขวาในคอนโซลการจัดการ) โดยใช้นโยบาย Spike Arrest ก่อนและ นโยบายข้อความไฮไลต์โฟลว์ เป็นขั้นสุดท้าย
<SharedFlow name="default"> <Step> <Name>Spike-Arrest</Name> </Step> <Step> <Name>Extract-Token</Name> </Step> <Step> <Name>Auth-Flow-Callout</Name> </Step> </SharedFlow>
แอตทริบิวต์การกำหนดค่าโฟลว์ที่แชร์
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
SharedFlow |
|||
name |
ชื่อของขั้นตอนที่แชร์ ซึ่งต้องไม่ซ้ำกันภายในองค์กร
อักขระที่คุณได้รับอนุญาตให้ใช้ในชื่อจะถูกจำกัดดังต่อไปนี้:
A-Za-z0-9_- |
ไม่มี | ใช่ |
revision |
หมายเลขการแก้ไขของการกำหนดค่าโฟลว์ที่แชร์ คุณไม่จําเป็นต้องตั้งค่า เนื่องจาก Apigee Edge จะติดตามการแก้ไขปัจจุบันของ ขั้นตอนที่แชร์ | ไม่มี | ไม่ได้ |
องค์ประกอบการกำหนดค่าโฟลว์ที่แชร์
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
SharedFlow |
กำหนดลำดับของนโยบายในขั้นตอนที่แชร์ | ไม่มี | ใช่ |
Step |
กำหนดขั้นตอน -- ขั้นตอนในลำดับของโฟลว์ | ไม่มี | ใช่ |
Name |
ระบุชื่อรายการที่ขั้นตอนอ้างอิง ค่าขององค์ประกอบนี้ควรเป็น เหมือนกับตัวระบุที่ไม่ซ้ำกันของสินค้า เช่น ค่าแอตทริบิวต์ชื่อของนโยบาย | ไม่มี | ใช่ |
นโยบาย
/sharedflowbundle/policies
เช่นเดียวกับในพร็อกซี API ไดเรกทอรี /policies
ในกลุ่มโฟลว์ที่แชร์จะมี
XML การกำหนดค่าสำหรับนโยบายทั้งหมดที่พร้อมแนบไปกับขั้นตอนที่แชร์ในแพ็กเกจ
นโยบายจะใช้องค์ประกอบย่อยร่วมกัน แม้ว่าชุดย่อยนี้จะเพิ่มประสิทธิภาพด้วยองค์ประกอบที่
นโยบายนี้โดยเฉพาะ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีกำหนดค่านโยบายได้ที่หัวข้อเกี่ยวกับนโยบาย
ที่คุณต้องการ นอกจากนี้ คุณยังสามารถเข้าถึงเรื่องเหล่านี้จากข้อมูลอ้างอิงนโยบาย
ภาพรวม
แหล่งข้อมูล
/sharedflowbundle/resources
ทรัพยากรคือสคริปต์ โค้ด และการเปลี่ยนรูปแบบ XSL ที่แนบไปกับขั้นตอนที่แชร์ได้ ด้วยนโยบาย โดยข้อมูลเหล่านี้จะปรากฏในส่วนสคริปต์ของเครื่องมือแก้ไขโฟลว์ที่แชร์ในการจัดการ UI
โปรดดูที่ไฟล์ทรัพยากรสำหรับ ประเภททรัพยากร
โพสต์คำถามในฟอรัมนักพัฒนาซอฟต์แวร์ Apigee