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