การอ้างอิงการกําหนดค่าชุดโฟลว์ที่แชร์

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X
info

โฟลว์ที่แชร์เป็นฟังก์ชันการทำงานที่นำกลับมาใช้ซ้ำได้ซึ่งคล้ายกับพร็อกซี 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 และ minorVersion 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> ย่อยรายการเดียวเท่านั้น คุณจะเพิ่มโฟลว์ที่แชร์ได้เพียงรายการเดียว ลงในแพ็กเกจโฟลว์ที่แชร์

ไม่มี ใช่

โฟลว์ที่แชร์

/sharedflowbundle/sharedflows/default.xml

การกำหนดค่า SharedFlow จะกำหนดลำดับที่ควรเรียกใช้องค์ประกอบโฟลว์ องค์ประกอบ <Step> ย่อยขององค์ประกอบ <SharedFlow> แต่ละรายการจะระบุส่วนหนึ่งของลำดับ เช่น การเรียกใช้นโยบาย

การกำหนดค่า SharedFlow ต่อไปนี้จะระบุนโยบาย 3 รายการที่จะเรียกใช้ตามลำดับจากบนลงล่าง (จากซ้ายไปขวาในคอนโซลการจัดการ) โดยมีนโยบาย Spike Arrest เป็นนโยบายแรกและนโยบาย Flow Callout เป็นนโยบายสุดท้าย

<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