ขั้นตอนที่แชร์ซ้ําได้

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

คุณรวมนโยบายและทรัพยากรไว้ในขั้นตอนที่แชร์ซึ่งใช้ได้จากพร็อกซี API หลายรายการ หรือแม้กระทั่งจากขั้นตอนอื่นๆ ที่แชร์ร่วมกันได้ แม้ว่าจะเหมือนกับพร็อกซี แต่โฟลว์ที่แชร์จะไม่มีปลายทาง โดยจะใช้ได้จากพร็อกซี API หรือขั้นตอนที่แชร์ที่อยู่ในองค์กรเดียวกับขั้นตอนที่แชร์เท่านั้น

การรวมฟังก์ชันการทำงานที่มีประโยชน์ในหลายตำแหน่งไว้ในหลายตำแหน่งจะช่วยให้ขั้นตอนที่แชร์มีความสอดคล้อง ลดเวลาในการพัฒนา และจัดการโค้ดได้ง่ายขึ้น

วิดีโอต่อไปนี้จะแสดงวิธีสร้างและติดตามขั้นตอนที่แชร์ใน Edge UI

วิดีโอความยาว 5 นาทีต่อไปนี้จะแสดงวิธีสร้างและติดตามโฟลว์ที่แชร์ใน UI ของ Classic Edge (Edge สำหรับ Private Cloud เท่านั้น)

คุณสามารถเรียกใช้โฟลว์ที่แชร์ได้โดยใช้นโยบาย Flow callout นอกจากนี้ การแนบโฟลว์ที่แชร์ไว้ใน Flow hook ช่วยให้คุณทำให้โฟลว์ที่แชร์ทำงานก่อนพร็อกซีหรือคำขอเป้าหมาย หรือ หลังพร็อกซีหรือการตอบสนองเป้าหมายได้

สำหรับข้อมูลอ้างอิงเกี่ยวกับนโยบายโฟลว์ไฮไลต์ โปรดดูนโยบายโฟลว์ไฮไลต์ ดูข้อมูลเพิ่มเติมเกี่ยวกับฮุกโฟลว์ได้ที่การแนบโฟลว์ที่แชร์โดยใช้ Flow hook

เช่น สมมติว่าคุณมีฟังก์ชันการทำงานในหลายตำแหน่ง หรือต้องใช้ API เดียวกันในองค์กรเพื่อให้เป็นมาตรฐานเดียวกัน คุณอาจมีขั้นตอนที่แชร์สำหรับแต่ละหมวดหมู่ เช่น

  • ความปลอดภัย พร้อมด้วยรหัสการให้สิทธิ์ที่ใช้ OAuth และการยืนยันคีย์ API รวมถึงรหัสการป้องกันภัยคุกคาม
  • การบันทึก สำหรับสร้างข้อความแสดงข้อผิดพลาดมาตรฐาน
  • สื่อกลาง สำหรับการเปลี่ยนรูปแบบข้อความ XML และ JSON

ในภาพประกอบต่อไปนี้ พร็อกซี API 2 รายการจะมีการเรียก (ด้วยนโยบาย Flowต้องระบุ) ไปยังขั้นตอนที่แชร์เพื่อตรวจสอบสิทธิ์คำขอของผู้ใช้ที่เข้ามาใหม่ มีการทำให้ AuthSharedFlow ใช้งานได้แยกกับองค์กรก่อนพร็อกซี เพื่อให้พร้อมรองรับคำขอจากพร็อกซี ขั้นตอนที่แชร์ร่วมกันสามารถพัฒนาและจัดการโดยทีมที่รับผิดชอบนโยบายบริษัทอย่างกว้างๆ จากนั้นจึงใช้ในพร็อกซีโดยทีมสายธุรกิจที่สร้างแอปที่เชี่ยวชาญยิ่งขึ้น

การพัฒนากระบวนการที่ใช้ร่วมกัน

เมื่อพัฒนาโฟลว์ที่แชร์ คุณต้องทดสอบด้วยการเรียกที่ส่งไปยังพร็อกซี API เสมอ กล่าวคือ คุณจะส่งคำขอไปยังโฟลว์ที่แชร์โดยตรงไม่ได้เหมือนกับพร็อกซี API แต่คุณจะส่งคำขอไปยังพร็อกซี API แทน ซึ่งจะเรียกไปยังขั้นตอนที่แชร์แทน

ขั้นตอนขั้นสูงในการพัฒนาโฟลว์ที่แชร์มีดังนี้

  1. ดูว่าชุดฟีเจอร์ที่แชร์ควรเป็นอะไร

    ตัวอย่างเช่น คุณอาจต้องการรวมฟีเจอร์การจัดการการเข้าชม รวมถึงการระงับการเพิ่มขึ้นของการเข้าชม วิธีนี้จะทำให้คุณจัดการการกำหนดค่านอกเวิร์กโฟลว์ของผู้ที่ใช้ตรรกะสายงานธุรกิจได้

  2. พัฒนาขั้นตอนที่แชร์โดยใช้นโยบายและทรัพยากรการสนับสนุน เหมือนกับเวลาพัฒนาพร็อกซี API

    ขั้นตอนที่ใช้ร่วมกันคือลำดับขั้นตอนตามเงื่อนไข ดังนั้น การพัฒนาพร็อกซีจึงเหมือนกับการพัฒนาพร็อกซี API คุณสามารถรวมนโยบายและทรัพยากรที่อาจรวมในพร็อกซีได้

    ตัวอย่างเช่น ในฐานะที่เป็นส่วนหนึ่งของการสนับสนุนการจัดการการเข้าชม คุณอาจใช้นโยบาย Spike Arrest ที่อนุญาตให้มีคำขอเพียง 30 รายการต่อวินาที ตามตัวอย่างต่อไปนี้

    <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
    <DisplayName>Spike Arrest</DisplayName>
    <Properties/>
    <Identifier ref="request.header.some-header-name"/>
    <MessageWeight ref="request.header.weight"/>
    <Rate>30ps</Rate>
</SpikeArrest>

    จากนั้น คุณอาจแนบนโยบาย Spike Arrest เป็นขั้นตอนหนึ่งลงในขั้นตอนที่แชร์สำหรับการจัดการการรับส่งข้อมูลได้ นโยบายจะดำเนินการกับพร็อกซี API ที่เรียกใช้โฟลว์ที่แชร์

    <SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
</SharedFlow>

    ดูข้อมูลเกี่ยวกับวิธีเริ่มต้นโฟลว์ที่แชร์ในคอนโซลการจัดการได้ที่การสร้างโฟลว์ที่แชร์ใน Edge UI

    เช่นเดียวกับพร็อกซี API คุณสามารถนำเข้าไฟล์ ZIP ที่มีอาร์ติแฟกต์ต้นทางของโฟลว์ที่แชร์ได้ (ดูข้อมูลเพิ่มเติมเกี่ยวกับการนำเข้าพร็อกซีได้ที่นำเข้าพร็อกซี API ใหม่) ตัวอย่างต่อไปนี้แสดงวิธีนำเข้าขั้นตอนที่แชร์กับ Management API

    curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \
-u email:password
  3. ทำให้ขั้นตอนที่แชร์ใช้งานได้กับสภาพแวดล้อมก่อนที่จะทำให้พร็อกซีหรือขั้นตอนที่แชร์ใช้งานได้ คุณทำให้ขั้นตอนที่แชร์ใช้งานได้ในลักษณะเดียวกับที่คุณทำให้พร็อกซี API ใช้งานได้ (สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการทำให้ใช้งานได้)

    ขั้นตอนที่แชร์ต้องอยู่ในองค์กรเดียวกันและทำให้ใช้งานได้ในสภาพแวดล้อมเดียวกันกับพร็อกซี API และโฟลว์อื่นๆ ที่แชร์ซึ่งใช้โฟลว์นั้น การทำให้โฟลว์ที่แชร์ใช้งานได้ก่อนพร็อกซีจะช่วยให้แก้ไขการพึ่งพาพร็อกซีบนโฟลว์ที่แชร์ในขณะที่ทำให้ใช้งานได้ได้

    คุณสามารถทำให้โฟลว์ที่แชร์ใช้งานได้ด้วยการเรียก Management API ดังตัวอย่างต่อไปนี้

    curl -X POST --header "Content-Type: application/octet-stream" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \
-u email:password

    นอกจากนี้ คุณยังสามารถแทนที่ขั้นตอนที่แชร์ที่ใช้งานในปัจจุบันโดยไม่มีช่วงพักได้อีกด้วย (ซึ่งคล้ายกับพร็อกซี API โปรดดูหัวข้อทำให้พร็อกซี API ใช้งานได้โดยใช้ Management API สำหรับข้อมูลเพิ่มเติม) ต่อไปนี้คือแบบฟอร์มคำขอที่ใช้ API การจัดการ

    curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
-u email:password
  4. พัฒนาพร็อกซี API ที่ใช้เพื่อให้เรียกใช้โฟลว์ที่แชร์ในฐานะส่วนหนึ่งของโฟลว์ของตัวเองได้

    จากพร็อกซี API คุณจะเรียกใช้ขั้นตอนที่แชร์ได้ด้วยนโยบาย Flow callout (คุณยังแนบโฟลว์ที่แชร์ไปยังพร็อกซีได้โดยใช้ Flow hook ดังที่อธิบายไว้ในการแนบโฟลว์ที่แชร์โดยใช้ฮุกโฟลว์) โปรดดูบทแนะนำเกี่ยวกับการสร้างพร็อกซี API ที่หัวข้อสร้างพร็อกซี API แรกของคุณ

    หากต้องการใช้โฟลว์ที่แชร์ ให้เพิ่มนโยบาย Flow callout ลงในพร็อกซีหรือโฟลว์ที่แชร์ที่จะใช้โฟลว์นั้น เช่นเดียวกับนโยบายคำขอราคาเสนอบริการซึ่งคุณเรียกใช้บริการอื่น โฟลว์ไฮไลต์จะเรียกไปยังขั้นตอนที่แชร์ ต้องทำให้พร็อกซี API ใช้งานใช้งานได้หลังจากโฟลว์ที่แชร์ และต้องอยู่ในสภาพแวดล้อมเดียวกันกับโฟลว์ที่แชร์ ขั้นตอนที่แชร์จะต้องอยู่กับที่เมื่อคุณต้องการทดสอบการเรียกใช้ไปยังการเรียกใช้โดยใช้นโยบายโฟลว์ไฮไลต์

    ในโค้ดต่อไปนี้ นโยบาย Flowคำขอราคาเสนอ เรียกใช้ขั้นตอนที่แชร์ที่เรียกว่า traffic-management-shared

    <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
    <DisplayName>Traffic Management FlowCallout</DisplayName>
    <Properties/>
    <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
</FlowCallout>

    ดูข้อมูลเพิ่มเติมได้ที่การเรียกโฟลว์ที่แชร์จากพร็อกซี API หรือโฟลว์ที่แชร์

  5. ทำให้พร็อกซี API ใช้งานใช้งานได้เพื่อเริ่มใช้ขั้นตอนที่แชร์ (สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการทำให้ใช้งานได้โดยทั่วไป โปรดดูการทำความเข้าใจการทำให้ใช้งานได้)
  6. พัฒนาอย่างต่อเนื่องด้วยการติดตาม เช่นเดียวกับที่คุณทำโดยใช้พร็อกซี API

    เมื่อใช้พร็อกซี API คุณจะพัฒนาโฟลว์ที่แชร์ได้โดยเรียกใช้และติดตามซ้ำๆ จนกว่าจะมีตรรกะตามที่ต้องการ ในกรณีนี้ เนื่องจากขั้นตอนที่แชร์จะไม่ทำงานด้วยตนเอง คุณจึงเรียกใช้ปลายทางของพร็อกซีและติดตามพร็อกซีได้

    มีขั้นตอนดังนี้

    1. ตรวจสอบว่าทั้งโฟลว์ที่แชร์และพร็อกซี API ที่เรียกใช้ด้วยนโยบาย Flowที่แตกต่างกัน อยู่ในองค์กรเดียวกันและทำให้ใช้งานได้ในสภาพแวดล้อมเดียวกัน
    2. ในแท็บติดตามของพร็อกซี API ให้เริ่มติดตามพร็อกซี API
    3. ส่งคำขอไปยังปลายทางของพร็อกซีในพร็อกซี API โฟลว์จากปลายทางต้องรวมนโยบาย Flow callout ที่เรียกไปยังโฟลว์ที่แชร์
    4. ในแท็บติดตาม ให้ตรวจสอบโฟลว์จากพร็อกซี API ไปยังโฟลว์ที่แชร์

      โปรดสังเกตว่าในการติดตาม โฟลว์ที่แชร์จะแสดงเป็นชุดขั้นตอนหรือนโยบายที่อยู่ในกล่องสีเทา ไอคอนที่แสดงนโยบาย Flowคำขอราคาเสนอ ก่อนขั้นตอนที่แชร์ (ดูข้อมูลเพิ่มเติมเกี่ยวกับการติดตามได้ที่การใช้เครื่องมือติดตาม)

การสร้างขั้นตอนที่ใช้ร่วมกันใน Edge UI

เมื่อใช้ UI ของ Apigee Edge เพื่อสร้างโฟลว์ที่แชร์ คุณจะสร้างโฟลว์ได้ตั้งแต่ต้นหรือนำเข้าแหล่งที่มาของโฟลว์ที่มีอยู่เป็นไฟล์ .zip ของแพ็กเกจโฟลว์

  1. เข้าถึงหน้าโฟลว์ที่แชร์ตามที่อธิบายไว้ด้านล่าง ในหน้าโฟลว์ที่แชร์ คุณจะดูรายการโฟลว์ที่แชร์ในองค์กร รวมถึงแก้ไขหรือลบโฟลว์ในรายการได้

    Edge

    วิธีเข้าถึงหน้าโฟลว์ที่แชร์โดยใช้ Edge UI

    1. ลงชื่อเข้าใช้ apigee.com/edge
    2. เลือกองค์กรที่มีโฟลว์ที่แชร์ โปรดดูการสลับระหว่างองค์กรของคุณ

      ขั้นตอนที่แชร์จะพร้อมใช้งานกับพร็อกซี API และโฟลว์ที่แชร์ซึ่งทำให้ใช้งานได้กับสภาพแวดล้อมจากองค์กรนี้ กิจกรรมจากภายนอกองค์กรนี้จะไม่พร้อมใช้งาน

    3. เลือกพัฒนา > โฟลว์ที่แชร์ในแถบนำทางด้านซ้าย

    Classic Edge (Private Cloud)

    วิธีเข้าถึงหน้าโฟลว์ที่แชร์โดยใช้ UI แบบคลาสสิกของ Edge

    1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ
    2. เลือกองค์กรที่มีโฟลว์ที่แชร์ โปรดดูการสลับระหว่างองค์กรของคุณ

      ขั้นตอนที่แชร์จะพร้อมใช้งานกับพร็อกซี API และโฟลว์ที่แชร์ซึ่งทำให้ใช้งานได้กับสภาพแวดล้อมจากองค์กรนี้ กิจกรรมจากภายนอกองค์กรนี้จะไม่พร้อมใช้งาน

    3. เลือก API > โฟลว์ที่แชร์ในแถบนำทางด้านบน
  2. คลิกปุ่ม + โฟลว์ที่แชร์ เพื่อเริ่มเพิ่มขั้นตอนที่แชร์ใหม่
  3. ในหน้าสร้างโฟลว์ที่แชร์ ให้เลือกว่าต้องการสร้างโฟลว์ใหม่อย่างไร
    • สร้างขั้นตอนใหม่ตั้งแต่ต้น คุณจะกำหนดค่านโยบายและทรัพยากรเป็นขั้นตอนในกระบวนการได้
      1. เลือกว่างโฟลว์ที่แชร์
      2. ป้อนค่าชื่อ ชื่อนี้จะเป็นชื่อที่พร็อกซี API และขั้นตอนที่แชร์อื่นๆ ใช้ในการอ้างอิงโฟลว์ที่แชร์นี้ ชื่อควรสื่อความหมายสำหรับนักพัฒนาซอฟต์แวร์ที่ใช้โฟลว์
      3. ป้อนคำอธิบายเพื่อให้ข้อมูลเพิ่มเติมเกี่ยวกับการทำงานของขั้นตอนนี้
      4. คลิกถัดไป
      5. เลือกสภาพแวดล้อมที่คุณต้องการให้โฟลว์ใหม่ใช้งานได้ (ไม่บังคับ)

        ตัวอย่างเช่น หากคุณจะทดสอบโฟลว์ที่แชร์จากพร็อกซี API ที่ทำให้ใช้งานได้กับสภาพแวดล้อมการทดสอบ ให้ทำให้โฟลว์ที่แชร์ใช้งานได้เพื่อทดสอบ

      6. คลิกสร้างและทำให้ใช้งานได้เพื่อสร้างโฟลว์ที่แชร์ใหม่และทำให้ใช้งานได้กับสภาพแวดล้อมที่คุณเลือก หากไม่เลือกสภาพแวดล้อม ระบบจะสร้างโฟลว์ที่แชร์ แต่จะไม่ทำให้ใช้งานได้

    • สร้างขั้นตอนที่แชร์จากแหล่งที่มาที่มีอยู่โดยการอัปโหลดแพ็กเกจโฟลว์
      1. เลือกแพ็กเกจโฟลว์ที่แชร์เพื่อระบุไฟล์ .zip ที่มีอาร์ติแฟกต์ที่คุณต้องการในขั้นตอนใหม่

        แพ็กเกจโฟลว์ที่แชร์มีอาร์ติแฟกต์ต้นทางของโฟลว์ที่แชร์ เช่น หากต้องการดาวน์โหลดโฟลว์ที่แชร์จาก Edge UI คุณจะมีไฟล์ .zip ที่มีแพ็กเกจโฟลว์

      2. คลิกถัดไป
      3. คลิกเลือกไฟล์เพื่อเรียกดูไฟล์ .zip ที่มีแหล่งที่มาของขั้นตอนที่แชร์ที่คุณต้องการนำเข้า
      4. ในช่องชื่อโฟลว์ที่แชร์ ให้ป้อนชื่อสำหรับโฟลว์ที่นำเข้า ชื่อนี้จะเป็นชื่อที่พร็อกซี API และขั้นตอนที่แชร์อื่นๆ ใช้ในการอ้างอิงโฟลว์ที่แชร์นี้ ชื่อควรสื่อความหมายสำหรับนักพัฒนาซอฟต์แวร์ที่ใช้โฟลว์
      5. คลิกถัดไป
      6. คลิกสร้างเพื่อสร้างขั้นตอนใหม่จากแหล่งที่มาที่คุณกำลังนำเข้า

การเรียกใช้ขั้นตอนที่แชร์จากพร็อกซี API หรือโฟลว์ที่แชร์

คุณเรียกใช้โฟลว์ที่แชร์จากพร็อกซีหรือจากโฟลว์ที่แชร์รายการอื่นได้โดยใช้ นโยบาย Flow callout

  1. ใน Edge UI ให้ค้นหาพร็อกซีหรือโฟลว์ที่แชร์ซึ่งคุณต้องการเรียกใช้โฟลว์ที่แชร์รายการอื่น
  2. ใน Navigator ที่อยู่ถัดจากนโยบาย ให้คลิกปุ่ม +
  3. ในรายการนโยบาย ภายในส่วนขยาย ให้คลิกไฮไลต์
  4. ป้อนชื่อและชื่อที่แสดง (ตัวระบุที่ไม่ซ้ำกัน) แล้วเลือกขั้นตอนที่แชร์ซึ่งจะเรียกนโยบายนี้
  5. คลิกเพิ่ม
  6. เพิ่มนโยบาย Flow callout ใหม่ลงในพร็อกซีที่คุณต้องการทำการเรียก

ดูเพิ่มเติม

เชน API พร็อกซีร่วมกัน