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