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

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

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

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

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

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

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

ดูข้อมูลอ้างอิงเกี่ยวกับนโยบาย FlowCallout ได้ที่นโยบาย FlowCallout ดูข้อมูลเพิ่มเติมเกี่ยวกับフックโฟลว์ได้ที่การแนบโฟลว์ที่แชร์โดยใช้フックโฟลว์

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

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

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

การสร้างขั้นตอนที่แชร์

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

ขั้นตอนระดับสูงในการพัฒนาขั้นตอนที่แชร์มีดังนี้

  1. พิจารณาว่าชุดฟีเจอร์ที่แชร์ควรเป็นอย่างไร

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

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

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

    ตัวอย่างเช่น ในการสนับสนุนการจัดการการรับส่งข้อมูล คุณอาจใช้นโยบายการตรวจจับการพุ่งสูงขึ้นเพื่ออนุญาตคำขอเพียง 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>

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

    คุณสามารถนําเข้าไฟล์ ZIP ที่มีอาร์ติแฟกต์แหล่งที่มาของโฟลว์ที่แชร์ได้เช่นเดียวกับการนําเข้าพร็อกซี API (ดูข้อมูลเพิ่มเติมเกี่ยวกับการนําเข้าพร็อกซีที่หัวข้อนําเข้าพร็อกซี 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 คุณจะเรียกใช้โฟลว์ที่แชร์ด้วยนโยบาย FlowCallout (คุณยังแนบโฟลว์ที่แชร์กับพร็อกซีได้โดยใช้ Flowhook ตามที่อธิบายไว้ในการแนบโฟลว์ที่แชร์โดยใช้ Flowhook) ดูบทแนะนําเบื้องต้นเกี่ยวกับการสร้างพร็อกซี API ได้ที่สร้างพร็อกซี API รายการแรก

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

    ในโค้ดต่อไปนี้ นโยบาย FlowCallout จะเรียกใช้โฟลว์ที่แชร์ซึ่งเรียกว่า 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 ที่เรียกใช้โฟลว์ด้วยนโยบาย FlowCallout อยู่ในองค์กรเดียวกันและติดตั้งใช้งานในสภาพแวดล้อมเดียวกัน
    2. ในแท็บการติดตามของพร็อกซี API ให้เริ่มการติดตามพร็อกซี API
    3. ส่งคําขอไปยังปลายทางของพร็อกซีในพร็อกซี API โฟลว์จากปลายทางต้องมีนโยบาย FlowCallout ที่เรียกใช้โฟลว์ที่แชร์
    4. ในแท็บการติดตาม ให้ตรวจสอบโฟลว์จากพร็อกซี API ไปยังโฟลว์ที่แชร์

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

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

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

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

    Edge

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

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

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

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

    คลาสสิก Edge (Private Cloud)

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

    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 ที่มีอาร์ติแฟกต์ที่ต้องการใช้ในโฟลว์ใหม่

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

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

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

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

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

ดูเพิ่มเติม

การต่อ API Proxies เข้าด้วยกัน