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

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

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

ขั้นตอนที่ 1: สร้างข้อกำหนด OpenAPI

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

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

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

    ผลิตภัณฑ์ Hello World API ที่แสดงการตั้งค่าช่องทั้งหมด

ขั้นตอนที่ 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

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

วิธีดูเอกสารประกอบข้อมูลอ้างอิงของ API

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

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

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