ขั้นตอนที่ 6: เผยแพร่ API

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

ในขั้นตอนนี้ คุณจะเผยแพร่ API ไปยังพอร์ทัลโดยทำตามขั้นตอนต่อไปนี้:
1. สร้างข้อมูลจำเพาะของ OpenAPI
2. สร้างพร็อกซี API จากข้อมูลจำเพาะ
3. สร้างผลิตภัณฑ์ API
4. เผยแพร่ API ไปยังพอร์ทัล

ขั้นตอนที่ 1: สร้างข้อมูลจำเพาะของ OpenAPI

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

วิธีสร้างข้อมูลจำเพาะของ OpenAPI

  1. เลือกพัฒนา > ข้อมูลจำเพาะ ในแถบนำทางด้านซ้ายเพื่อเปิดหน้าข้อมูลจำเพาะ
  2. คลิก + ข้อมูลจำเพาะ > นำเข้า URL
  3. ป้อนข้อมูลต่อไปนี้ในกล่องโต้ตอบการนำเข้า
  4. ชื่อการนำเข้า: helloworld

  5. URL การนำเข้า: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. คลิกนำเข้า

ขั้นตอนที่ 2: สร้างพร็อกซี API จากข้อมูลจำเพาะ

สร้างพร็อกซี API จากข้อมูลจำเพาะของ OpenAPI ที่อธิบาย API

วิธีสร้างพร็อกซี API จากข้อมูลจำเพาะของ OpenAPI:

  1. ในหน้าข้อมูลจำเพาะ ให้วางเคอร์เซอร์เหนือข้อมูลจำเพาะ helloworld เพื่อแสดงเมนูการดำเนินการ
  2. คลิก เพื่อสร้างพร็อกซี API จากข้อมูลจำเพาะ
    ระบบจะเปิดวิซาร์ดสร้างพร็อกซีและกรอกข้อมูลในหน้า "รายละเอียด" ล่วงหน้าโดยใช้ค่าจาก ข้อมูลจำเพาะของ OpenAPI
  3. แก้ไขช่องคำอธิบาย ดังนี้ พร็อกซี API สำหรับ Hello World
  4. คลิกถัดไป

  5. ในหน้านโยบาย ให้ทำดังนี้

    • ในส่วนความปลอดภัย: การให้สิทธิ์ ให้เลือกส่งผ่าน (ไม่มีการให้สิทธิ์)
    • ในส่วนความปลอดภัย: เบราว์เซอร์ ให้เลือกเพิ่มส่วนหัว CORS

    หน้า "นโยบายทั่วไป" ในวิซาร์ดสร้างพร็อกซีที่มีการเลือก "ส่งผ่าน" และ "เพิ่มส่วนหัว CORS"

  6. คลิกถัดไป

  7. ในหน้าโฟลว์ ให้ตรวจสอบว่าได้เลือกการดำเนินการทั้งหมดแล้ว และคลิกถัดไป
    สร้างโฟลว์พร็อกซี

  8. ในหน้าโฮสต์เสมือน ให้ตรวจสอบว่าได้เลือกโฮสต์เสมือนทั้งหมดแล้ว และคลิกถัดไป

  9. ในหน้าสรุป ให้เลือกสภาพแวดล้อมที่ต้องการทำให้ใช้งานได้ในส่วนการทำให้ใช้งานได้ที่ไม่บังคับ

  10. คลิกสร้าง

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

ขั้นตอนที่ 3: สร้างผลิตภัณฑ์ API

สร้างผลิตภัณฑ์ API ที่มีทรัพยากร API ที่คุณต้องการเปิดเผยต่อผู้ใช้ API

วิธีสร้างผลิตภัณฑ์ API:

  1. เลือกเผยแพร่ > ผลิตภัณฑ์ API ในแถบนำทางด้านซ้ายเพื่อเปิดหน้าผลิตภัณฑ์ API
  2. คลิก + ผลิตภัณฑ์ API.
    หน้าสินค้าใหม่จะปรากฏขึ้น
  3. ป้อนรายละเอียดผลิตภัณฑ์ สำหรับผลิตภัณฑ์ API
    หมายเหตุ: ระบบจะแสดงช่องชื่อที่แสดงและคำอธิบายในพอร์ทัลเมื่อคุณ เผยแพร่ผลิตภัณฑ์ API โดยค่าเริ่มต้น คุณสามารถแก้ไขค่าได้ใน ขั้นตอนที่ 4: เผยแพร่ API ไปยังพอร์ทัล
    ช่อง ค่า
    ชื่อ Hello World
    ชื่อที่แสดง Hello World
    คำอธิบาย ตัวอย่าง Hello World อย่างง่าย
    สภาพแวดล้อม เลือกสภาพแวดล้อมที่ทำให้พร็อกซี API ใช้งานได้
    การเข้าถึง สาธารณะ
    อนุมัติคำขอเข้าถึงโดยอัตโนมัติ เปิดใช้
    Quota (เว้นว่างไว้)
    ขอบเขต OAuth ที่อนุญาต (เว้นว่างไว้)
  4. ในส่วนทรัพยากร API ให้คลิกเพิ่มพร็อกซี เพื่อระบุพร็อกซี API ที่จะเพิ่มลงในผลิตภัณฑ์ API
    กล่องโต้ตอบเพิ่มทรัพยากร API จะปรากฏขึ้น
  5. คลิกพร็อกซี API (หากยังไม่ได้เลือก) แล้วเลือก Mock-Target-API ในรายการ
  6. คลิกเพิ่ม
  7. คลิกบันทึก เพื่อบันทึกผลิตภัณฑ์ API

    ผลิตภัณฑ์ API Hello World ที่แสดงฟิลด์ทั้งหมดที่ตั้งค่าไว้

ขั้นตอนที่ 4: เผยแพร่ API ไปยังพอร์ทัล

เผยแพร่ API ไปยังพอร์ทัลเพื่อให้ลูกค้าได้เรียนรู้และใช้ API

วิธีเผยแพร่ API ไปยังพอร์ทัล:

  1. ไปที่หน้า API ในพอร์ทัลโดยทำดังนี้
    1. เลือกเผยแพร่ > พอร์ทัล ในแถบนำทางด้านซ้าย
    2. คลิกในแถวพอร์ทัลแรกของฉัน เพื่อเปิดพอร์ทัล
    3. คลิกแคตตาล็อก API เพื่อแสดงหน้า API
  2. คลิก +
  3. เลือก Hello World ในกล่องโต้ตอบเพิ่มผลิตภัณฑ์ API ลงในแคตตาล็อก แล้วคลิกถัดไป
  4. ในส่วนรายละเอียด API ให้กำหนดค่าตัวเลือกต่อไปนี้
    • เลือกเผยแพร่แล้ว (แสดงในแคตตาล็อก) เพื่อเผยแพร่ API ไปยังพอร์ทัล
    • สำหรับรูปภาพที่แสดง:
      1. คลิกเลือกรูปภาพ
      2. คลิก home-background.jpg จากรายการรูปภาพที่มีอยู่ในกล่องโต้ตอบเลือกรูปภาพ
      3. คลิกเลือก
      4. ดูตัวอย่างรูปภาพ แล้วคลิกเลือก
    • สำหรับหมวดหมู่ ให้ป้อนเริ่มต้นใช้งาน แล้วกด Enter

    ตั้งค่าอื่นๆ ทั้งหมดเป็นค่าเริ่มต้น

  5. ในส่วนเอกสารประกอบ API ให้ทำดังนี้เพื่อสร้างเอกสารอ้างอิง API จากข้อมูลจำเพาะของ OpenAPI โดยอัตโนมัติ:
    1. เลือกเอกสาร OpenAPI
    2. คลิกเลือกเอกสาร
    3. เลือกแท็บข้อมูลจำเพาะของฉัน (หากยังไม่ได้เลือก)
    4. เลือก helloworld จากรายการข้อมูลจำเพาะ
    5. คลิกเลือก
  6. คลิกบันทึก เพื่อบันทึกรายละเอียด API

    API "Hello World" ที่แสดงช่องที่ตั้งค่าทั้งหมด

วิธีดูเอกสารอ้างอิง API

  1. คลิกพอร์ทัลจริง เพื่อดูการเปลี่ยนแปลงในพอร์ทัลจริง (หรือรีเฟรชพอร์ทัลจริงหากเปิดอยู่ในแท็บอื่น)
  2. คลิกAPI ในแถบนำทางด้านบนเพื่อดู API ที่เผยแพร่
  3. คลิกการ์ด Hello World เพื่อดูเอกสารอ้างอิง API ลองใช้ API ของคุณเลย

API เป้าหมายจำลองที่เผยแพร่พร้อมแผง "ลองใช้ API นี้"

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