คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
ในฐานะผู้ให้บริการ API คุณต้องมีวิธีแสดง API, แจ้งข้อมูลเกี่ยวกับ API แก่นักพัฒนาแอป, ลงชื่อสมัครใช้นักพัฒนาแอป และอนุญาตให้นักพัฒนาแอปลงทะเบียนแอป Apigee Edge มีพอร์ทัลบริการสําหรับนักพัฒนาซอฟต์แวร์ที่คุณสามารถใช้สร้างและเปิดตัวเว็บไซต์ที่กําหนดเองเพื่อให้บริการเหล่านี้แก่ชุมชนนักพัฒนาซอฟต์แวร์ ดูข้อมูลเพิ่มเติมเกี่ยวกับพอร์ทัลนักพัฒนาแอปได้ที่หัวข้อพอร์ทัลนักพัฒนาแอปคืออะไร
ส่วนต่อไปนี้อธิบายแนวคิดหลักที่คุณควรทำความเข้าใจก่อนแก้ปัญหาเกี่ยวกับพอร์ทัลนักพัฒนาแอป
วิธีการทํางานของ SmartDocs
คุณสามารถนำเข้าข้อมูลจำเพาะของ OpenAPI (JSON หรือ YAML) หรือ WADL ที่อธิบาย API ของคุณไปยัง SmartDocs และใช้เพื่อเผยแพร่เอกสารอ้างอิง API ไปยังพอร์ทัลได้ เอกสารอ้างอิง API จะปรากฏในแท็บ API ในพอร์ทัลโดยอัตโนมัติ นักพัฒนาซอฟต์แวร์จะค้นพบเอกสารประกอบของ API ผ่านพอร์ทัลและสามารถส่งคําขอ API แบบเรียลไทม์ได้ เนื่องจากคำขอ API มาจากเบราว์เซอร์ จึงต้องมีการรองรับ CORS (Cross-Origin Resource Sharing) เพื่อให้คำขอดำเนินการสำเร็จ การรองรับ CORS มาจากพร็อกซี "smartdocs" ใน Edge (ในองค์กร "VALIDATE") ซึ่งทำหน้าที่เป็นพร็อกซีสำหรับคำขอ SmartDocs ทั้งหมดไปยังปลายทางที่ต้องการ ระบบจะสร้างพร็อกซี "smartdocs" เมื่อคุณติดตั้ง SmartDocs
เช่น
URL ของพร็อกซี SmartDocs จะแสดงเป็นพร็อพเพอร์ตี้ที่กำหนดค่าได้ที่การกําหนดค่า -> SmartDocs -> URL ของพร็อกซี SmartDocs คุณอาจต้องแก้ไข URL นี้หาก API อยู่ในเครือข่ายส่วนตัวและคำขอ API ที่เผยแพร่อยู่โดยใช้ SmartDocs จากพอร์ทัลไม่สำเร็จ
วิธีที่พอร์ทัลนักพัฒนาซอฟต์แวร์สื่อสารกับ Edge
พอร์ทัลนักพัฒนาแอปจะจัดเก็บและดึงข้อมูลส่วนใหญ่ที่แสดงจาก Edge รวมถึง SmartDocs, นักพัฒนาแอป, ผลิตภัณฑ์ และแอปของนักพัฒนาแอป คุณสามารถกําหนดค่าข้อมูลองค์กร Edge และข้อมูลเข้าสู่ระบบของ devadmin ได้โดยใช้คําสั่งเมนูการกําหนดค่า -> Devportal
ดูข้อมูลเพิ่มเติมได้ที่ การสื่อสารระหว่างพอร์ทัลกับ Edge