เผยแพร่ 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 ภาพรวมนั้นแสดงถึงเวอร์ชันที่เจาะจงของข้อกำหนดในพื้นที่เก็บข้อมูล หากคุณแก้ไขข้อมูลจำเพาะของ 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 ให้พิจารณาสาเหตุและวิธีแก้ไขที่เป็นไปได้ต่อไปนี้

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

     schemes:
   - https
   - http

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