คุณกำลังดูเอกสารประกอบของ 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 |
เวอร์ชันของสคีมาการกำหนดค่าแพ็กเกจโฟลว์ที่แชร์ซึ่งสอดคล้องกับโฟลว์ที่แชร์นี้ ค่าที่รองรับในขณะนี้มีค่าเดียวคือ majorVersion 4 และ childVersion 0 การตั้งค่านี้อาจใช้ในอนาคตเพื่อเปิดใช้วิวัฒนาการของรูปแบบแพ็กเกจโฟลว์ที่แชร์ | 4.0 | ไม่ได้ |
CreatedAt และCreatedBy |
วันที่/เวลา (ในเวลา Epoch) ที่สร้างแพ็กเกจขั้นตอนที่แชร์ พร้อมกับอีเมลของผู้ใช้ที่สร้างแพ็กเกจขั้นตอนดังกล่าว | ||
Description |
คำอธิบายที่เป็นข้อความของขั้นตอนที่แชร์ หากมี คำอธิบายจะแสดงใน UI การจัดการ Edge | ไม่มีข้อมูล | ไม่ได้ |
DisplayName |
ชื่อที่ใช้ง่ายซึ่งอาจแตกต่างจากแอตทริบิวต์ name ของการกำหนดค่าขั้นตอนที่แชร์ |
ไม่มีข้อมูล | ไม่ได้ |
LastModifiedAt และLastModifiedBy |
วันที่/เวลา (ในเวลา Epoch) ที่แก้ไขแพ็กเกจขั้นตอนที่แชร์ครั้งล่าสุด พร้อมกับอีเมลของผู้ใช้ที่แก้ไข | ||
Policies |
รายการนโยบายในไดเรกทอรี /policies ของขั้นตอนที่แชร์นี้ โดยปกติคุณจะเห็นองค์ประกอบนี้ต่อเมื่อมีการสร้างขั้นตอนที่แชร์โดยใช้ UI การจัดการ Edge เท่านั้น นี่เป็นเพียงการตั้งค่า "ไฟล์ Manifest" ที่ออกแบบมาเพื่อแสดงเนื้อหาของโฟลว์ที่แชร์ |
ไม่มีข้อมูล | ไม่ได้ |
Resources |
รายการทรัพยากร (JavaScript, Python, Java, XSLT) ในไดเรกทอรี /resources ของโฟลว์ที่แชร์นี้ โดยปกติคุณจะเห็นองค์ประกอบนี้ก็ต่อเมื่อสร้างโฟลว์ที่แชร์โดยใช้ UI การจัดการ Edge เท่านั้น นี่เป็นเพียงการตั้งค่า "ไฟล์ Manifest" ที่ออกแบบมาเพื่อ
ให้ผู้ใช้เห็นเนื้อหาของโฟลว์ที่แชร์ |
ไม่มีข้อมูล | ไม่ได้ |
SharedFlows |
ระบุขั้นตอนที่แชร์ซึ่งแพ็กเกจนี้มี
โปรดทราบว่าปัจจุบันองค์ประกอบนี้รองรับ <SharedFlow> ย่อยเพียง 1 ขั้นตอน คุณจะเพิ่มขั้นตอนที่แชร์ลงในแพ็กเกจโฟลว์ที่แชร์ได้เพียง 1 ขั้นตอน |
ไม่มีข้อมูล | มี |
ขั้นตอนที่แชร์
/sharedflowbundle/sharedflows/default.xml
การกำหนดค่า SharedFlow กำหนดลำดับที่อิลิเมนต์โฟลว์ควรดำเนินการ องค์ประกอบย่อย <Step> ขององค์ประกอบ <SharedFlow> แต่ละองค์ประกอบระบุส่วนหนึ่งของลำดับ เช่น การเรียกใช้นโยบาย
การกำหนดค่า SharedFlow ต่อไปนี้ระบุนโยบาย 3 รายการที่จะดำเนินการในลำดับจากบนลงล่าง (จากซ้ายไปขวาในคอนโซลการจัดการ) โดยที่นโยบายการระงับการเพิ่มขึ้นก่อนและนโยบายไฮไลต์โฟลว์เป็นลำดับสุดท้าย
<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 |
ระบุชื่อรายการที่ขั้นตอนอ้างอิง ค่าขององค์ประกอบนี้ควรเหมือนกับตัวระบุที่ไม่ซ้ำกันของสินค้า เช่น ค่าแอตทริบิวต์ name ของนโยบาย | ไม่มีข้อมูล | มี |
นโยบาย
/sharedflowbundle/policies
เช่นเดียวกับในพร็อกซี API ไดเรกทอรี /policies
ในกลุ่มโฟลว์ที่แชร์จะมี XML การกำหนดค่าสำหรับนโยบายทั้งหมดที่พร้อมใช้งานกับโฟลว์ที่แชร์ในแพ็กเกจ
นโยบายจะแชร์องค์ประกอบชุดย่อย แม้ว่าชุดย่อยนี้จะเสริมด้วยองค์ประกอบที่เฉพาะเจาะจงสำหรับนโยบาย ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีกำหนดค่านโยบายในหัวข้อเกี่ยวกับนโยบายที่ต้องการ คุณยังเข้าถึงข้อมูลเหล่านี้จากภาพรวมข้อมูลอ้างอิงนโยบายได้ด้วย
แหล่งข้อมูล
/sharedflowbundle/resources
ทรัพยากรคือสคริปต์ โค้ด และการเปลี่ยนรูปแบบ XSL ที่แนบกับโฟลว์ที่แชร์โดยใช้นโยบายได้ ซึ่งจะปรากฏในส่วนสคริปต์ของเครื่องมือแก้ไขขั้นตอนที่แชร์ใน UI การจัดการ
ดูไฟล์ทรัพยากรสำหรับประเภททรัพยากรที่รองรับ
โพสต์คำถามในฟอรัมนักพัฒนาซอฟต์แวร์ Apigee