เผยแพร่ API ของคุณ (เวอร์ชันต้นฉบับ)

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

เผยแพร่ API ไปยังพอร์ทัลเพื่อให้นักพัฒนาแอปพร้อมใช้งาน ตามที่อธิบายไว้ในส่วนต่อไปนี้

ภาพรวมการเผยแพร่ API

กระบวนการเผยแพร่ API ไปยังพอร์ทัลมี 2 ขั้นตอน ดังนี้

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

เมื่อเผยแพร่ API ไปยังพอร์ทัล ระบบจะทำการอัปเดตต่อไปนี้ในพอร์ทัลโดยอัตโนมัติ

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

    หมายเหตุ: คุณแก้ไขเนื้อหาของหน้านี้โดยตรงไม่ได้ แต่จะไม่ปรากฏในรายการหน้าเว็บในพอร์ทัลของคุณ

  • มีการเพิ่มลิงก์ไปยังหน้าข้อมูลอ้างอิง API ในหน้า API
    หน้า API (รวมอยู่ในตัวอย่างพอร์ทัล) มีรายการ API ทั้งหมดที่เผยแพร่ไปยังพอร์ทัลของคุณ พร้อมกับลิงก์ไปยังเอกสารอ้างอิง API ที่เกี่ยวข้องสำหรับข้อมูลเพิ่มเติม

    หมายเหตุ: คุณแก้ไขเนื้อหาของหน้านี้โดยตรงไม่ได้ แต่จะไม่ปรากฏในรายการหน้าเว็บในพอร์ทัลของคุณ

ภาพรวมของข้อกำหนดของ OpenAPI คืออะไร

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

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

การเพิ่มการรองรับ CORS ไปยังพร็อกซี API

ก่อนเผยแพร่ API คุณจะต้องเพิ่มการรองรับ CORS ลงในพร็อกซี API เพื่อรองรับคำขอข้ามต้นทางฝั่งไคลเอ็นต์

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

โปรดดูข้อมูลเกี่ยวกับการเพิ่มการรองรับ CORS ในพร็อกซี API ก่อนเผยแพร่ API โปรดดูที่การเพิ่มการรองรับ CORS ไปยังพร็อกซี API

หมายเหตุ: เบราว์เซอร์รุ่นใหม่ส่วนใหญ่บังคับใช้ CORS ตรวจสอบรายการเบราว์เซอร์ที่รองรับทั้งหมด ดูรายละเอียดเชิงลึกเกี่ยวกับ CORS ได้ที่คำแนะนำ W3C การแชร์ทรัพยากรข้ามโดเมน

สำรวจหน้า API

วิธีเข้าถึงหน้า API

  1. เลือกเผยแพร่ > พอร์ทัล แล้วเลือกพอร์ทัลของคุณ
  2. คลิก API ในหน้าแรกของพอร์ทัล

หรือเลือก API ในเมนูแบบเลื่อนลงของพอร์ทัลในแถบนำทางด้านบน

รายการ API จะปรากฏขึ้น

เอกสารอ้างอิง API

ตามที่ไฮไลต์ในรูปก่อนหน้านี้ หน้า API จะช่วยให้คุณทำสิ่งต่อไปนี้ได้

เพิ่ม API ไปยังพอร์ทัล

หมายเหตุ: คุณเพิ่ม API ไปยังพอร์ทัลได้สูงสุด 100 รายการ

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

  1. เลือกเผยแพร่ > พอร์ทัล แล้วเลือกพอร์ทัลของคุณ
  2. คลิก API ในหน้าแรกของพอร์ทัล
    หรือเลือก API ในเมนูแบบเลื่อนลงของพอร์ทัลในแถบนำทางด้านบน
  3. คลิก + API
    กล่องโต้ตอบเพิ่มผลิตภัณฑ์ API ไปยังพอร์ทัลจะปรากฏขึ้น

  4. ในแท็บผลิตภัณฑ์ API ในกล่องโต้ตอบ ให้เลือกผลิตภัณฑ์ API ที่ต้องการเพิ่มลงในพอร์ทัล

  5. คลิกถัดไป

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

    อีกวิธีหนึ่งคือ

    • ไม่มีข้อกำหนด และเพิ่มข้อกำหนดในภายหลังหลังจากที่เผยแพร่ API แล้ว ตามที่อธิบายไว้ในภาพรวมของข้อกำหนด
    • เลือกข้อกำหนดอื่นเพื่อเลือกหรืออัปโหลดข้อกำหนดใหม่

  7. เลือกช่องทำเครื่องหมายเผยแพร่เพื่อเผยแพร่ API ไปยังพอร์ทัลของคุณ ยกเลิกการเลือกเผยแพร่แล้วหากคุณยังไม่พร้อมที่จะเผยแพร่ API
    คุณเปลี่ยนการตั้งค่าในภายหลังได้ตามที่อธิบายไว้ในการเผยแพร่หรือการยกเลิกการเผยแพร่ API ในพอร์ทัล

  8. ในส่วนกลุ่มเป้าหมาย ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้เพื่อจัดการกลุ่มเป้าหมายสำหรับ API โดยการอนุญาตให้เข้าถึง

    • ผู้ใช้ที่ไม่ระบุชื่อ เพื่อให้ผู้ใช้ทั้งหมดสามารถดูหน้าเว็บได้
    • ผู้ใช้ที่ลงทะเบียนเพื่อให้เฉพาะผู้ใช้ที่ลงทะเบียนเท่านั้นที่สามารถดูหน้าเว็บได้

    คุณเปลี่ยนการตั้งค่าในภายหลังได้ตามที่อธิบายไว้ในการจัดการกลุ่มเป้าหมายสำหรับ API ในพอร์ทัล

  9. คลิกเสร็จสิ้น

ดูภาพรวมของข้อกำหนด

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

วิธีสร้างสแนปชอตของข้อกำหนดของ OpenAPI

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

  4. คลิก ไอคอนภาพรวม

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

  5. เลือกข้อกำหนดที่มีอยู่จากเมนูแบบเลื่อนลง "แหล่งที่มาของสแนปชอต" หรือเลือกเลือกข้อกำหนดอื่นเพื่อเลือกหรืออัปโหลดข้อกำหนดใหม่ที่จะใช้ในการสร้างเอกสารประกอบสำหรับ API หรือจะเลือกไม่มีข้อกำหนดเพื่อนำข้อกำหนดปัจจุบันออกก็ได้

  6. คลิกอัปเดตภาพรวม (หรือนำสแนปชอตออก หากเลือก "ไม่ระบุ)"

เอกสารอ้างอิง API สร้างขึ้นจากข้อกำหนดและเพิ่มลงในหน้าการอ้างอิง API

เผยแพร่หรือเลิกเผยแพร่ API ในพอร์ทัลของคุณ

วิธีเผยแพร่หรือเลิกเผยแพร่ API ในพอร์ทัล

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

จัดการกลุ่มเป้าหมายสำหรับ API ในพอร์ทัลของคุณ

จัดการกลุ่มเป้าหมายสำหรับ API ในพอร์ทัลโดยอนุญาตให้เข้าถึงสิ่งต่อไปนี้

  • ผู้ใช้ทั้งหมด
  • ผู้ใช้ที่ลงทะเบียนเท่านั้น

วิธีจัดการกลุ่มเป้าหมายสำหรับ API ในพอร์ทัล

  1. เลือกเผยแพร่ > พอร์ทัล แล้วเลือกพอร์ทัลของคุณ
  2. คลิก API ในหน้าแรกของพอร์ทัล
    หรือเลือก API ในเมนูแบบเลื่อนลงของพอร์ทัลในแถบนำทางด้านบน
  3. วางเคอร์เซอร์เหนือ API ที่ต้องการใช้จัดการกลุ่มเป้าหมายเพื่อแสดงการดำเนินการ
  4. คลิก ไอคอนการตั้งค่า
  5. ในส่วน "ผู้ชม" ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้
    • ผู้ใช้ที่ไม่ระบุชื่อเพื่ออนุญาตให้ผู้ใช้ทั้งหมดดูผลิตภัณฑ์ API ได้
    • ผู้ใช้ที่ลงทะเบียนเพื่อให้เฉพาะผู้ใช้ที่ลงทะเบียนดูผลิตภัณฑ์ API ได้
  6. คลิกบันทึก

นำ API ออกจากพอร์ทัล

วิธีนำ API ออกจากพอร์ทัล

  1. เลือกเผยแพร่ > พอร์ทัล แล้วเลือกพอร์ทัลของคุณ
  2. คลิก API ในหน้าแรกของพอร์ทัล
    หรือเลือก API ในเมนูแบบเลื่อนลงของพอร์ทัลในแถบนำทางด้านบน
  3. วางเคอร์เซอร์เหนือ API ในรายการเพื่อแสดงเมนูการทำงาน
  4. คลิก ลบ

แก้ปัญหาเกี่ยวกับ API ที่เผยแพร่

เมื่อใช้ "ลองใช้" หากแสดงข้อผิดพลาด TypeError: Failed to fetch ให้พิจารณาสาเหตุและวิธีแก้ปัญหาที่เป็นไปได้ต่อไปนี้

  • สำหรับข้อผิดพลาดของเนื้อหาผสม ข้อผิดพลาดนั้นอาจเกิดจากปัญหาเกี่ยวกับ UI ที่ทราบแล้ว วิธีแก้ปัญหาเบื้องต้นที่เป็นไปได้วิธีหนึ่งคือ ตรวจสอบว่าคุณได้ระบุ HTTPS ก่อน HTTP ในคำจำกัดความ schemes ในข้อกำหนดของ OpenAPI เช่น 

     schemes:
   - https
   - http

  • สำหรับข้อผิดพลาดเกี่ยวกับการจำกัด CORS (การแชร์ทรัพยากรข้ามต้นทาง) โปรดตรวจสอบว่าพร็อกซี API รองรับ CORS หรือไม่ CORS เป็นกลไกมาตรฐานที่เปิดใช้คำขอข้ามต้นทางฝั่งไคลเอ็นต์ โปรดดูการเพิ่มการรองรับ CORS สำหรับพร็อกซี API ตรวจสอบว่าได้เปิดใช้ CORS ในเบราว์เซอร์ด้วย