จัดการข้อกำหนดเฉพาะของคุณ

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

Apigee Edge คือพื้นที่สำหรับจัดเก็บข้อกำหนดของ OpenAPI จัดการข้อกำหนดของ OpenAPI ตามที่อธิบายไว้ในส่วนต่อไปนี้

ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อกำหนดของ OpenAPI ได้ที่ข้อกำหนดของ OpenAPI คืออะไร

สำรวจรายการข้อมูลจำเพาะ

วิธีเข้าถึงรายการข้อกำหนด

  1. ลงชื่อเข้าใช้ apigee.com/edge
  2. เลือกองค์กร
  3. เลือกพัฒนา > ข้อกำหนดในเมนูการนำทางด้านข้าง

รายการข้อกำหนดเฉพาะและโฟลเดอร์ปัจจุบันจะปรากฏ

รายการข้อมูลจำเพาะ

ดังที่ไฮไลต์ในภาพก่อนหน้า คุณสามารถทำสิ่งต่อไปนี้จากรายการข้อกำหนดเฉพาะ

สร้างข้อมูลจำเพาะของ OpenAPI ใหม่

วิธีสร้างข้อกำหนดจำเพาะของ OpenAPI ใหม่

  1. คลิกพัฒนา > ข้อกำหนดในแถบนำทางด้านข้าง
  2. คลิก + ข้อกำหนด
  3. คลิกข้อกำหนดใหม่ในเมนูแบบเลื่อนลง ตัวแก้ไขข้อกำหนดจะเปิดขึ้น
  4. แทนที่ข้อกำหนดตัวอย่างด้วยรายละเอียดข้อกำหนด OpenAPI ของคุณเอง
    โปรดดูหัวข้อสร้างข้อกำหนดเฉพาะโดยใช้เครื่องมือแก้ไขข้อกำหนด
  5. คลิกบันทึกเพื่อบันทึกข้อกำหนด
  6. ป้อนชื่อสำหรับข้อกำหนดเมื่อมีข้อความแจ้ง
  7. คลิกบันทึก

นำเข้าข้อกำหนดของ OpenAPI

หากต้องการนำเข้าข้อกำหนดของ OpenAPI ให้ทำดังนี้

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

แก้ไขข้อมูลจำเพาะของ OpenAPI ที่มีอยู่

วิธีเปิดข้อมูลจำเพาะของ OpenAPI ที่มีอยู่

  1. คลิกพัฒนา > ข้อกำหนดในแถบนำทางด้านข้าง
  2. คลิกแถวที่เกี่ยวข้องกับข้อมูลจำเพาะในรายการข้อกำหนด
  3. แก้ไขข้อกําหนดในเครื่องมือแก้ไขข้อกําหนด
    โปรดดูหัวข้อสร้างข้อกำหนดเฉพาะโดยใช้เครื่องมือแก้ไขข้อกำหนด

สร้างพร็อกซี API จากข้อกำหนดในรายการข้อกำหนด

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

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

วิธีสร้างพร็อกซี API จากข้อกำหนดของ OpenAPI ในรายการข้อกำหนด

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

เปลี่ยนชื่อข้อกำหนด

วิธีเปลี่ยนชื่อข้อกำหนด

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

ย้ายข้อกำหนดไปยังโฟลเดอร์

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

ลบข้อกําหนด

คุณลบข้อกำหนดออกจากที่จัดเก็บไฟล์ได้เมื่อไม่จำเป็นต้องใช้อีกแล้วหรือใช้งานไม่ได้

วิธีลบข้อกําหนด

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