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

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

ในขั้นตอนนี้ คุณจะได้เผยแพร่ 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. ในหน้า Virtual Hosts ให้ตรวจสอบว่าเลือกโฮสต์เสมือนทั้งหมดไว้แล้ว แล้วคลิก Next

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

  10. คลิกสร้าง

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

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

สร้างผลิตภัณฑ์ API ที่มีทรัพยากร API ที่คุณต้องการแสดงต่อผู้บริโภค API

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

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

    ผลิตภัณฑ์ Hello World API แสดงชุดฟิลด์ทั้งหมด

ขั้นตอนที่ 4: เผยแพร่ API ในพอร์ทัลของคุณ

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

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

  1. ไปที่หน้า API ในพอร์ทัล
    1. เลือกเผยแพร่ > พอร์ทัลในแถบนำทางด้านซ้าย
    2. คลิกแถวพอร์ทัลแรกของฉันเพื่อเปิดพอร์ทัล
    3. คลิกแคตตาล็อก API เพื่อแสดงหน้า API
  2. คลิก +
  3. เลือก Hey 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

Mock Target API ที่เผยแพร่ด้วยแผง "ลองใช้ API นี้"

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