ข้อมูลอ้างอิงการกําหนดค่าพร็อกซีของ API

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

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

หากคุณกำลังเรียนรู้วิธีสร้างพร็อกซี API ขอแนะนำให้เริ่มต้นด้วยหัวข้อสร้างพร็อกซี API อย่างง่าย

วิธีที่พบบ่อยที่สุดในการแก้ไขการกำหนดค่าพร็อกซีมีดังนี้

• การใช้ เครื่องมือแก้ไข XML ภายใน UI ของ Edge
• ดาวน์โหลดการกำหนดค่าและแก้ไขในเครื่องตามที่อธิบายไว้ในการพัฒนาการกำหนดค่าพร็อกซีในเครื่อง

การพัฒนาการกำหนดค่าพร็อกซีในเครื่อง

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

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

วิธีแก้ไขการกำหนดค่าพร็อกซีในเครื่องโดยใช้ UI

1. ดาวน์โหลดการกำหนดค่าพร็อกซีปัจจุบันใน UI ของ Edge (ในมุมมองพร็อกซี API ให้เลือกโปรเจ็กต์ > ดาวน์โหลดการแก้ไข)
2. สร้างไดเรกทอรีใหม่ในเครื่องของคุณ แล้วแตกไฟล์ ZIP ที่ดาวน์โหลดมาลงในไดเรกทอรีนั้น

   หากต้องการขยายไฟล์ ZIP คุณสามารถใช้ยูทิลิตี เช่น unzip ดังตัวอย่างต่อไปนี้

   mkdir myappdir
   unzip ./my-app_app_rev3_2019_04_20.zip -d myappdir

   เนื้อหาที่ขยายของไฟล์ ZIP ควรมีลักษณะคล้ายกับโครงสร้างที่อธิบายไว้ใน โครงสร้างพร็อกซี API

3. แก้ไขไฟล์ต้นฉบับตามที่จำเป็น ดูคำอธิบายของไฟล์ต้นฉบับในการกำหนดค่าพร็อกซีได้ที่ ไฟล์การกำหนดค่าและ โครงสร้างไดเรกทอรีของ API Proxy

   ตัวอย่างเช่น หากต้องการเปิดใช้การตรวจสอบสถานะในพร็อกซี API ให้แก้ไขไฟล์การกำหนดค่า TargetEndpoint ในไดเรกทอรี /apiproxy/targets/ ไฟล์เริ่มต้นในไดเรกทอรีนี้คือ default.xml แม้ว่าอาจมีไฟล์ที่มีชื่อต่างกันหากคุณใช้ เป้าหมายแบบมีเงื่อนไข

   ในกรณีนี้ หากไม่มีไฟล์การกำหนดค่า TargetEndpoint และไดเรกทอรีของไฟล์ ให้สร้างไฟล์และไดเรกทอรี

4. หลังจากแก้ไขไฟล์การกำหนดค่าพร็อกซีเสร็จแล้ว อย่าลืมบันทึกการเปลี่ยนแปลง
5. เปลี่ยนเป็นไดเรกทอรีใหม่ที่คุณสร้างขึ้นเมื่อขยายไฟล์ ZIP (รูทของ ไฟล์การกำหนดค่าที่ขยาย)

   ตัวอย่างเช่น หากคุณขยายไฟล์ลงในไดเรกทอรี /myappdir ให้เปลี่ยนไปที่ไดเรกทอรีนั้น ดังตัวอย่างต่อไปนี้

   cd myappdir

   คุณควรเปลี่ยนไปใช้ไดเรกทอรีนี้ก่อนที่จะเก็บไฟล์การกำหนดค่าพร็อกซีอีกครั้ง เนื่องจากคุณไม่ต้องการให้ไดเรกทอรี /myappdir รวมอยู่ในไฟล์ ZIP ไดเรกทอรีระดับบนสุดในไฟล์ ZIP ต้องเป็น /apiproxy

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

   zip my-new-proxy.zip -r .

   ไดเรกทอรีระดับบนสุดในไฟล์ ZIP ต้องเป็น /apiproxy

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

   Edge จะเพิ่มหมายเลขการแก้ไขของการกำหนดค่าพร็อกซีใหม่ให้คุณเมื่ออัปโหลด

7. อัปโหลดการกำหนดค่าพร็อกซีใหม่โดยใช้ UI ของ Edge (ในมุมมองพร็อกซี API ให้เลือกโปรเจ็กต์ > อัปโหลดการแก้ไขใหม่)

   หากได้รับข้อผิดพลาด เช่น Bundle is invalid. Empty bundle. ให้ตรวจสอบว่า ไดเรกทอรีระดับบนสุดของไฟล์ ZIP คือ /apiproxy หากไม่เป็นเช่นนั้น ให้เก็บไฟล์การกำหนดค่าพร็อกซีจากรูทของไดเรกทอรีที่ขยายแล้วอีกครั้ง

   หลังจากอัปโหลดการกำหนดค่าพร็อกซีใหม่แล้ว Edge จะเพิ่มหมายเลขรีวิชันและ แสดงในมุมมองสรุปรีวิชัน

   Edge จะไม่ติดตั้งใช้งานรีวิชันใหม่ให้คุณหลังจากที่คุณอัปโหลดด้วย UI

8. ทำให้การแก้ไขใหม่ใช้งานได้

ดูข้อมูลเพิ่มเติมได้ที่บทแนะนำ: วิธีดาวน์โหลดพร็อกซีโดยใช้ UI และ Management API ในชุมชน Apigee

โครงสร้างพร็อกซี API

พร็อกซี API ประกอบด้วยการกำหนดค่าต่อไปนี้

โครงสร้างไดเรกทอรีและเนื้อหาของพร็อกซี API

ส่วนประกอบในตารางด้านบนกำหนดโดยไฟล์การกำหนดค่าในโครงสร้างไดเรกทอรีต่อไปนี้

ไฟล์การกำหนดค่าและโครงสร้าง ไดเรกทอรีของพร็อกซี API

ส่วนนี้จะอธิบายไฟล์การกำหนดค่าและโครงสร้างไดเรกทอรีของพร็อกซี API

• การกำหนดค่าพื้นฐาน
• ProxyEndpoint
• TargetEndpoint
  • การกำหนดค่า TargetEndpoint ของ TLS/SSL
• นโยบาย
• โฟลว์
• แหล่งข้อมูล

การกำหนดค่าพื้นฐาน

/apiproxy/weatherapi.xml

การกำหนดค่าพื้นฐานสำหรับพร็อกซี API ซึ่งกำหนดชื่อของพร็อกซี API ชื่อต้องไม่ซ้ำกันภายในองค์กร

ตัวอย่างการกำหนดค่า

<APIProxy name="weatherapi">
</APIProxy>

องค์ประกอบการกำหนดค่าพื้นฐาน

ProxyEndpoint

รูปภาพต่อไปนี้แสดงขั้นตอนการส่งคำขอ/การตอบกลับ

/apiproxy/proxies/default.xml

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

ระบบจะจัดเก็บการกำหนดค่า ProxyEndpoint ตัวอย่างต่อไปนี้ไว้ใน /apiproxy/proxies

<ProxyEndpoint name="default">
  <PreFlow/>
  <Flows/>
  <PostFlow/>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
    <VirtualHost>default</VirtualHost>
  </HTTPProxyConnection>
  <FaultRules/>
  <DefaultFaultRule/>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>

องค์ประกอบการกำหนดค่าที่จำเป็นใน ProxyEndpoint พื้นฐานมีดังนี้

การกำหนดค่า ProxyEndpoint องค์ประกอบ

วิธีกำหนดค่า RouteRules

TargetEndpoint ที่มีชื่อหมายถึงไฟล์การกำหนดค่าใน /apiproxy/targets ซึ่ง RouteRule จะส่งต่อคำขอหลังจากที่ ProxyEndpoint ประมวลผลแล้ว

ตัวอย่างเช่น RouteRule ต่อไปนี้อ้างอิงถึงการกำหนดค่า /apiproxy/targets/myTarget.xml

<RouteRule name="default">
  <TargetEndpoint>myTarget</TargetEndpoint>
</RouteRule>

การเรียกใช้ URL โดยตรง

นอกจากนี้ ProxyEndpoint ยังเรียกใช้บริการแบ็กเอนด์ได้โดยตรงด้วย การเรียกใช้ URL โดยตรงจะข้ามการกำหนดค่า TargetEndpoint ที่มีชื่อภายใต้ /apiproxy/targets) ด้วยเหตุนี้ TargetEndpoint จึงเป็นการกำหนดค่าพร็อกซี API ที่ไม่บังคับ แม้ว่าในทางปฏิบัติแล้ว เราไม่แนะนำให้เรียกใช้โดยตรงจาก ProxyEndpoint

ตัวอย่างเช่น RouteRule ต่อไปนี้จะเรียกใช้ HTTP ไปยัง http://api.mycompany.com/v2

<RouteRule name="default">
  <URL>http://api.mycompany.com/v2</URL>
</RouteRule>

เส้นทางแบบมีเงื่อนไข

สามารถเชื่อมโยง RouteRules เพื่อรองรับการกำหนดเส้นทางแบบไดนามิกในขณะรันไทม์ คำขอขาเข้าสามารถ กำหนดเส้นทางไปยังการกำหนดค่า TargetEndpoint ที่มีชื่อ ไปยัง URL โดยตรง หรือไปยังการรวมกันของทั้ง 2 อย่าง โดยอิงตามส่วนหัว HTTP, เนื้อหาข้อความ, พารามิเตอร์การค้นหา หรือข้อมูลตามบริบท เช่น เวลาของ วัน, ภาษา ฯลฯ

Conditional RouteRules ทำงานเหมือนกับคำสั่งแบบมีเงื่อนไขอื่นๆ ใน Apigee Edge ดูข้อมูลอ้างอิงเกี่ยวกับเงื่อนไขและข้อมูลอ้างอิงเกี่ยวกับตัวแปร

ตัวอย่างเช่น การรวมกันของ RouteRule ต่อไปนี้จะประเมินคำขอขาเข้าก่อนเพื่อยืนยัน ค่าของส่วนหัว HTTP หากส่วนหัว HTTP routeTo มีค่า TargetEndpoint1 ระบบจะส่งต่อคำขอไปยัง TargetEndpoint ที่ชื่อ TargetEndpoint1 หากไม่ได้ระบุ ระบบจะส่งต่อคำขอขาเข้าไปยัง http://api.mycompany.com/v2

<RouteRule name="MyRoute">
  <Condition>request.header.routeTo = "TargetEndpoint1"</Condition>
  <TargetEndpoint>TargetEndpoint1</TargetEndpoint>
</RouteRule>
<RouteRule name="default">
  <URL>http://api.mycompany.com/v2</URL>
</RouteRule>

เส้นทาง Null

คุณกำหนด RouteRule ที่เป็น Null เพื่อรองรับสถานการณ์ที่ข้อความคำขอไม่จำเป็นต้องส่งต่อ ไปยัง TargetEndpoint ได้ ซึ่งจะมีประโยชน์เมื่อ ProxyEndpoint ทำการประมวลผลที่จำเป็นทั้งหมด เช่น การใช้ JavaScript เพื่อเรียกใช้บริการภายนอก หรือการดึงข้อมูลจากการค้นหาไปยังที่เก็บคีย์/ค่าของบริการ API

เช่น การกำหนดเส้นทางที่ไม่มีค่ามีดังนี้

<RouteRule name="GoNowhere"/>

เส้นทางที่กำหนดค่าเป็น Null แบบมีเงื่อนไขอาจมีประโยชน์ ในตัวอย่างต่อไปนี้ มีการกำหนดค่าเส้นทาง Null ให้ ดำเนินการเมื่อส่วนหัว HTTP request.header.X-DoNothing มีค่าอื่นที่ไม่ใช่ null

<RouteRule name="DoNothingOnDemand">
  <Condition>request.header.X-DoNothing != null</Condition>
</RouteRule>

โปรดทราบว่า RouteRules สามารถเชื่อมโยงกันได้ ดังนั้น Route ที่เป็น Null แบบมีเงื่อนไขจึงมักเป็นคอมโพเนนต์หนึ่งของชุด RouteRules ที่ออกแบบมาเพื่อรองรับการกำหนดเส้นทางแบบมีเงื่อนไข

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

<RouteRule name="DoNothingUnlessTheCacheIsStale">
  <Condition>lookupcache.LookupCache-1.cachehit is true</Condition>
</RouteRule>

TargetEndpoint

TargetEndpoint คือเทียบเท่าขาออกของ ProxyEndpoint TargetEndpoint ทำหน้าที่เป็นไคลเอ็นต์สำหรับบริการแบ็กเอนด์หรือ API โดยจะส่งคำขอและรับการตอบกลับ

พร็อกซี API ไม่จำเป็นต้องมี TargetEndpoint คุณกำหนดค่า ProxyEndpoints ให้เรียก URL ได้โดยตรง พร็อกซี API ที่ไม่มี TargetEndpoints มักจะมี ProxyEndpoint ที่ เรียกใช้บริการแบ็กเอนด์โดยตรง หรือได้รับการกำหนดค่าให้เรียกใช้บริการโดยใช้ Java หรือ JavaScript

การกำหนดค่า TargetEndpoint

/targets/default.xml

TargetEndpoint จะกำหนดการเชื่อมต่อขาออกจาก Apigee Edge ไปยังบริการหรือ ทรัพยากรอื่น

ตัวอย่างการกำหนดค่า TargetEndpoint มีดังนี้

<TargetEndpoint name="default">
  <PreFlow/>
  <Flows/>
  <PostFlow/>
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <SSLInfo/>
  </HTTPTargetConnection>
  <FaultRules/>
  <DefaultFaultRule/>
  <ScriptTarget/>
  <LocalTargetConnection/>
</TargetEndpoint>

การกำหนดค่า TargetEndpoint องค์ประกอบ

TargetEndpoint สามารถเรียกเป้าหมายได้ด้วยวิธีใดวิธีหนึ่งต่อไปนี้

• HTTPTargetConnection สำหรับการเรียก HTTP(S)
• LocalTargetConnection สำหรับการเชื่อมโยงพร็อกซีกับพร็อกซีในเครื่อง
• ScriptTarget สำหรับการเรียกใช้สคริปต์ Node.js ที่โฮสต์ที่ Edge

กำหนดค่าเพียง 1 รายการใน TargetEndpoint

การกำหนดค่า TargetEndpoint ของ TLS/SSL

โดยทั่วไปแล้ว TargetEndpoint จะต้องจัดการการเชื่อมต่อ HTTPS กับโครงสร้างพื้นฐานของแบ็กเอนด์ที่แตกต่างกัน ด้วยเหตุนี้ เราจึงรองรับการตั้งค่าการกำหนดค่า TLS/SSL หลายรายการ

TLS/SSL องค์ประกอบการกำหนดค่า TargetEndpoint

<Ciphers>
 <Cipher>TLS_RSA_WITH_3DES_EDE_CBC_SHA</Cipher>
 <Cipher>TLS_RSA_WITH_DES_CBC_SHA</Cipher>
</Ciphers>

<Protocols>
 <Protocol>TLSv1.1</Protocol>
 <Protocol>TLSv1.2</Protocol>
</Protocols>

<CommonName wildcardMatch="true">*.myhost.com</CommonName>

ตัวอย่าง TargetEndpoint ที่เปิดใช้การตรวจสอบสิทธิ์ไคลเอ็นต์ขาออก

<TargetEndpoint name="default">
  <HttpTargetConnection>
        <URL>https://myservice.com</URL>
    <SSLInfo>
      <Enabled>true</Enabled>
      <ClientAuthEnabled>true</ClientAuthEnabled>
      <KeyStore>myKeystore</KeyStore>
      <KeyAlias>myKey</KeyAlias>
      <TrustStore>myTruststore</TrustStore>
    </SSLInfo>
  </HttpTargetConnection>
</TargetEndpoint>

ดูวิธีการโดยละเอียดได้ที่การกำหนดค่า TLS จาก Edge ไปยังแบ็กเอนด์ (Cloud และ Private Cloud)

การใช้ตัวแปรโฟลว์เพื่อตั้งค่า TLS/SSL แบบไดนามิก

นอกจากนี้ คุณยังตั้งค่ารายละเอียด TLS/SSL แบบไดนามิกเพื่อรองรับข้อกำหนดรันไทม์ที่ยืดหยุ่นได้ด้วย ตัวอย่างเช่น หากพร็อกซีเชื่อมต่อกับเป้าหมาย 2 รายการที่อาจแตกต่างกัน (เป้าหมายทดสอบและเป้าหมายการใช้งานจริง) คุณสามารถตั้งค่าพร็อกซี API โดยทางโปรแกรมให้ตรวจหาสภาพแวดล้อมที่เรียกใช้ และตั้งค่าการอ้างอิงไปยังที่เก็บคีย์และที่เก็บที่เชื่อถือที่เหมาะสมแบบไดนามิก บทความในชุมชน Apigee ต่อไปนี้อธิบายสถานการณ์นี้โดยละเอียดและมีตัวอย่างพร็อกซี API ที่สามารถนำไปใช้ได้: Dynamic SSLInfo for TargetEndpoint using variable reference

ในตัวอย่างต่อไปนี้เกี่ยวกับวิธีตั้งค่าแท็ก <SSLInfo> ในการกำหนดค่า TargetEndpoint คุณระบุค่าได้ในขณะรันไทม์ เช่น โดย Java Callout, นโยบาย JavaScript หรือนโยบาย Assign Message ใช้ตัวแปรข้อความที่มีค่าที่คุณต้องการตั้งค่า

อนุญาตให้ใช้ตัวแปรในองค์ประกอบต่อไปนี้เท่านั้น

<SSLInfo>
    <Enabled>{myvars.ssl.enabled}</Enabled>
    <ClientAuthEnabled>{myvars.ssl.client.auth.enabled}</ClientAuthEnabled>
    <KeyStore>{myvars.ssl.keystore}</KeyStore>
    <KeyAlias>{myvars.ssl.keyAlias}</KeyAlias>
    <TrustStore>{myvars.ssl.trustStore}</TrustStore>
</SSLInfo>

การใช้ การอ้างอิงเพื่อตั้งค่า TLS/SSL แบบไดนามิก

เมื่อกำหนดค่า TargetEndpoint ที่ใช้ HTTPS คุณต้องพิจารณากรณีที่ใบรับรอง TLS/SSL หมดอายุ หรือการเปลี่ยนแปลงการกำหนดค่าระบบกำหนดให้คุณต้องอัปเดตใบรับรอง ในการติดตั้ง Edge สำหรับ Private Cloud เมื่อกำหนดค่า TLS/SSL โดยใช้ค่าแบบคงที่หรือโดย ใช้ตัวแปรโฟลว์ คุณอาจต้องรีสตาร์ทตัวประมวลผลข้อความ

ดูข้อมูลเพิ่มเติมได้ที่อัปเดตใบรับรอง TLS

อย่างไรก็ตาม คุณสามารถกำหนดค่า TargetEndpoint ให้ใช้การอ้างอิงไปยัง ที่เก็บคีย์หรือที่เก็บที่เชื่อถือแทนได้ ข้อดีของการใช้การอ้างอิงคือคุณสามารถอัปเดตการอ้างอิงให้ชี้ไปยังที่เก็บคีย์หรือที่เก็บที่เชื่อถืออื่นเพื่ออัปเดตใบรับรอง TLS/SSL ได้โดยไม่ต้องรีสตาร์ทตัวประมวลผลข้อความ

ตัวอย่างเช่น ด้านล่างนี้คือ TargetEndpoint ที่ใช้การอ้างอิงไปยังที่เก็บคีย์

<SSLInfo>
    <Enabled>true</Enabled>
    <ClientAuthEnabled>false</ClientAuthEnabled>
    <KeyStore>ref://keystoreref</KeyStore>
    <KeyAlias>myKeyAlias</KeyAlias>
</SSLInfo>

ใช้การเรียก API แบบ POST ต่อไปนี้เพื่อสร้างการอ้างอิงชื่อ keystoreref

curl -X POST  -H "Content-Type:application/xml" https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/references \
-d '<ResourceReference name="keystoreref">
    <Refers>myTestKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>' -u email:password

การอ้างอิงจะระบุชื่อของที่เก็บคีย์และประเภทของที่เก็บคีย์

ใช้การเรียก API แบบ GET ต่อไปนี้เพื่อดูข้อมูลอ้างอิง

curl -X GET https://api.enterprise.apigee.com/v1/o/[org_name}/e/{env_name}/references/keystoreref -u uname:password

หากต้องการเปลี่ยนการอ้างอิงในภายหลังให้ชี้ไปยังที่เก็บคีย์อื่น โดยตรวจสอบว่าชื่อแทนมีชื่อเดียวกัน ให้ใช้การเรียก PUT ต่อไปนี้

curl -X PUT -H "Content-Type:application/xml" https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/references/keystoreref \
-d '<ResourceReference name="keystoreref">
    <Refers>myNewKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>' -u email:password

TargetEndpoint ที่มีการจัดสรรภาระงานเป้าหมาย

TargetEndpoints รองรับการจัดสรรภาระงานใน TargetServer ที่มีชื่อหลายรายการโดยใช้อัลกอริทึมการจัดสรรภาระงาน 3 รายการ

ดูวิธีการโดยละเอียดได้ที่การปรับสมดุลโหลดในเซิร์ฟเวอร์แบ็กเอนด์

นโยบาย

ไดเรกทอรี /policies ในพร็อกซี API มีนโยบายทั้งหมดที่พร้อม แนบกับโฟลว์ในพร็อกซี API

องค์ประกอบการกำหนดค่านโยบาย

เอกสารแนบนโยบาย

รูปภาพต่อไปนี้แสดงลำดับการดำเนินการของโฟลว์พร็อกซี API

ดังที่แสดงด้านบน

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

<Step><Name>MyPolicy</Name></Step>

ระบบจะบังคับใช้นโยบายตามลำดับที่แนบกับโฟลว์ เช่น

<Step><Name>FirstPolicy</Name></Step>
<Step><Name>SecondPolicy</Name></Step>

การกำหนดค่าการแนบนโยบาย องค์ประกอบ

โฟลว์

ProxyEndpoint และ TargetEndpoint จะกำหนดไปป์ไลน์สำหรับการประมวลผลข้อความคำขอและการตอบกลับ ไปป์ไลน์การประมวลผลประกอบด้วยโฟลว์คำขอและโฟลว์การตอบกลับ แต่ละคำขอ โฟลว์และโฟลว์การตอบกลับจะแบ่งย่อยออกเป็น PreFlow, โฟลว์ "แบบมีเงื่อนไข" หรือ "แบบมีชื่อ" ที่ไม่บังคับอย่างน้อย 1 รายการ และ PostFlow

• PreFlow: ทำงานเสมอ ดำเนินการก่อนโฟลว์แบบมีเงื่อนไข
• PostFlow: ทำงานเสมอ ดำเนินการหลังจากโฟลว์แบบมีเงื่อนไข

นอกจากนี้ คุณยังเพิ่ม PostClientFlow ไปยัง ProxyEndpoint ได้ ซึ่งจะทำงานหลังจากที่ระบบส่งการตอบกลับไปยังแอปไคลเอ็นต์ที่ขอมา เฉพาะนโยบายการบันทึกข้อความและส่วนขยายการบันทึกของ Google Stackdriver เท่านั้นที่แนบไปกับโฟลว์นี้ได้ PostClientFlow ช่วยลดเวลาในการตอบสนองของพร็อกซี API และทำให้ข้อมูลพร้อมใช้งานสำหรับการ บันทึกที่ไม่ได้คำนวณจนกว่าจะมีการส่งคืนการตอบกลับไปยังไคลเอ็นต์ เช่น client.sent.start.timestamp และ client.sent.end.timestamp โดยโฟลว์นี้ใช้ เพื่อวัดช่วงเวลาระหว่างการประทับเวลาเริ่มต้นและสิ้นสุดสำหรับข้อความตอบกลับเป็นหลัก

ดูวิดีโอวิธีการสั้นๆ

ต่อไปนี้คือตัวอย่าง PostClientFlow ที่มีนโยบายการบันทึกข้อความแนบอยู่

    ...
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
    <PostClientFlow>
        <Request/>
        <Response>
            <Step>
                <Name>Message-Logging-1</Name>
            </Step>
        </Response>
    </PostClientFlow>
    ...

ไปป์ไลน์การประมวลผลพร็อกซี API จะเรียกใช้โฟลว์ตามลำดับต่อไปนี้

ไปป์ไลน์คำขอ

1. PreFlow ของคำขอพร็อกซี
2. โฟลว์แบบมีเงื่อนไขของคำขอพร็อกซี (ไม่บังคับ)
3. Proxy Request PostFlow
4. Target Request PreFlow
5. โฟลว์แบบมีเงื่อนไขของคำขอเป้าหมาย (ไม่บังคับ)
6. Target Request PostFlow

ไปป์ไลน์การตอบกลับ:

1. Target Response PreFlow
2. โฟลว์แบบมีเงื่อนไขของการตอบกลับเป้าหมาย (ไม่บังคับ)
3. Target Response PostFlow
4. PreFlow ของการตอบกลับพร็อกซี
5. โฟลว์แบบมีเงื่อนไขของการตอบกลับพร็อกซี (ไม่บังคับ)
6. Proxy Response PostFlow
7. การตอบกลับ PostClientFlow (ไม่บังคับ)

เฉพาะโฟลว์ที่มีไฟล์แนบนโยบายเท่านั้นที่ต้องกำหนดค่าในการกำหนดค่า ProxyEndpoint หรือ TargetEndpoint คุณต้องระบุ PreFlow และ PostFlow ในการกำหนดค่า ProxyEndpoint หรือ TargetEndpoint เท่านั้นเมื่อต้องบังคับใช้นโยบายระหว่างการประมวลผล PreFlow หรือ PostFlow

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

โฟลว์แบบมีเงื่อนไข

ProxyEndpoint และ TargetEndpoint รองรับโฟลว์แบบมีเงื่อนไขได้ไม่จำกัดจำนวน (หรือที่เรียกว่า "โฟลว์ที่มีชื่อ")

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

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

• URI คำขอ
• คำกริยา HTTP (GET/PUT/POST/DELETE)
• ค่าของพารามิเตอร์การค้นหา ส่วนหัว และพารามิเตอร์แบบฟอร์ม
• โรคอื่นๆ อีกหลายประเภท

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

<Flows>
  <Flow name="TokenEndpoint">
    <Condition>proxy.pathsuffix MatchesPath "/accesstoken"</Condition>
    <Request>
      <Step>
        <Name>GenerateAccessToken</Name>
      </Step>
    </Request>
  </Flow>
</Flows>

องค์ประกอบการกำหนดค่าโฟลว์

การประมวลผลขั้นตอน

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

ตัวอย่างเช่น ในการกำหนดค่าโฟลว์ต่อไปนี้ คำขอขาเข้าใดๆ ที่ไม่มี คำต่อท้ายเส้นทาง /first หรือ /second จะทำให้ ThirdFlow ทำงาน ซึ่งบังคับใช้นโยบายที่ชื่อ Return404

<Flows>
  <Flow name="FirstFlow">
    <Condition>proxy.pathsuffix MatchesPath "/first"</Condition>
    <Request>
      <Step><Name>FirstPolicy</Name></Step>
    </Request>
  </Flow>
  <Flow name="SecondFlow">
    <Condition>proxy.pathsuffix MatchesPath "/second"</Condition>
    <Request>
      <Step><Name>FirstPolicy</Name></Step>
      <Step><Name>SecondPolicy</Name></Step>
    </Request>
  </Flow>
  <Flow name="ThirdFlow">
    <Request>
      <Step><Name>Return404</Name></Step>
    </Request>
  </Flow>
</Flows>

แหล่งข้อมูล

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

ดูไฟล์ทรัพยากรสำหรับประเภททรัพยากรที่รองรับ

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

นโยบายในสภาพแวดล้อมใดก็ได้สามารถอ้างอิงทรัพยากรที่จัดเก็บไว้ที่ระดับองค์กรได้ นโยบายในสภาพแวดล้อมนั้นสามารถอ้างอิงทรัพยากรที่จัดเก็บไว้ที่ระดับสภาพแวดล้อมได้ ทรัพยากรที่จัดเก็บไว้ที่ระดับพร็อกซี API จะอ้างอิงได้เฉพาะนโยบายในพร็อกซี API นั้น