คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่
เอกสารประกอบของ Apigee X info
การเผยแพร่คือกระบวนการทำให้ API พร้อมใช้งานสำหรับนักพัฒนาแอปเพื่อ การใช้งาน
วิดีโอ: วิดีโอต่อไปนี้เป็นการแนะนำการเผยแพร่ API ในภาพรวม
การเผยแพร่ API เกี่ยวข้องกับงานต่อไปนี้ ซึ่งอธิบายไว้ในหัวข้อนี้
- สร้างผลิตภัณฑ์ API ใน Edge ที่รวม API ของคุณไว้ด้วยกัน
- ลงทะเบียนนักพัฒนาแอปใน Edge
- ลงทะเบียนแอปของนักพัฒนาแอปใน Edge
- จัดทำเอกสารประกอบและการสนับสนุนจากชุมชนสำหรับ API
งานที่ 1: สร้างผลิตภัณฑ์ API ใน Edge
งานแรกในการเผยแพร่คือการสร้างผลิตภัณฑ์ API ผลิตภัณฑ์ API คือชุดทรัพยากร API ที่นำเสนอเป็นแพ็กเกจแก่นักพัฒนาแอป สร้างผลิตภัณฑ์ API โดยใช้ Edge Management API หรือ UI (ดูข้อมูลเพิ่มเติมเกี่ยวกับผลิตภัณฑ์ API ได้ที่ผลิตภัณฑ์ API คืออะไร)
ในรูปนี้ API ประกอบด้วยผลิตภัณฑ์ 2 รายการ ซึ่งแต่ละรายการมีทรัพยากร API 3 รายการ
ในฐานะผู้ให้บริการ API คุณมีหน้าที่รับผิดชอบในการสร้าง API และผลิตภัณฑ์ API เพื่อจัดการ การควบคุมการเข้าถึง ข้อจำกัดในการใช้งาน และข้อกำหนดทางธุรกิจอื่นๆ ตัวอย่างเช่น คุณ อาจทำสิ่งต่อไปนี้
- เผยแพร่ผลิตภัณฑ์ API ฟรีที่อนุญาตให้เข้าถึงทรัพยากร API ได้แบบอ่านอย่างเดียว
- เผยแพร่ผลิตภัณฑ์ API รายการที่ 2 ในราคาต่ำสุดที่อนุญาตให้เข้าถึงทรัพยากร API เดียวกันได้แบบสิทธิ์การอ่าน/เขียนเหมือนกับเวอร์ชันฟรี แต่มีขีดจำกัดการเข้าถึงต่ำ เช่น 1, 000 คำขอต่อวัน
- เผยแพร่ผลิตภัณฑ์ API รายการที่ 3 ในราคาสูงที่อนุญาตให้เข้าถึงทรัพยากร API เดียวกันได้แบบอ่าน/เขียน แต่มีขีดจำกัดการเข้าถึงสูง
สิ่งสำคัญที่ควรทราบคือ Edge มีความยืดหยุ่นในการสร้างผลิตภัณฑ์ API ที่ตรงกับข้อกำหนดทางธุรกิจของ API
ดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างผลิตภัณฑ์ API ได้ที่สร้างผลิตภัณฑ์ API
งานที่ 2: ลงทะเบียนนักพัฒนาแอปใน Edge
นักพัฒนาแอปเป็นผู้สร้างแอปที่ใช้ API ของคุณ นักพัฒนาแอปต้องลงทะเบียนใน Apigee Edge ก่อนจึงจะลงทะเบียนแอปได้ เมื่อลงทะเบียนแอปแล้ว นักพัฒนาแอปจะได้รับคีย์ API ที่ จะให้สิทธิ์เข้าถึง API แก่แอป
คุณควบคุมผู้ที่มีสิทธิ์เข้าถึง API ได้ผ่านกระบวนการลงทะเบียนแอป คุณสามารถลบนักพัฒนาแอปได้ทุกเมื่อ ซึ่งจะเป็นการยกเลิกคีย์ API ทั้งหมดที่เชื่อมโยงกับนักพัฒนาแอปรายนั้น จึงเป็นการปฏิเสธไม่ให้นักพัฒนาแอปรายนั้นเข้าถึง API ของคุณ
ในฐานะผู้ให้บริการ API คุณเป็นผู้กำหนดวิธีลงทะเบียนนักพัฒนาแอป ตัวอย่างเช่น คุณสามารถใช้กระบวนการลงทะเบียนด้วยตนเอง ที่กำหนดให้นักพัฒนาแอปที่สนใจติดต่อองค์กรของคุณเพื่อ ลงทะเบียน นักพัฒนาแอปที่สนใจต้องระบุข้อมูลที่จำเป็นทั้งหมด เช่น อีเมล แอดเดรส ชื่อและนามสกุล รวมถึงชื่อบริษัท หากอนุมัติคำขอของนักพัฒนาแอป คุณ สามารถใช้ Edge Management UI เพื่อลงทะเบียนนักพัฒนาแอปด้วยตนเอง ดูข้อมูลเพิ่มเติมได้ที่การจัดการนักพัฒนาแอปสำหรับ เพิ่มเติม
นอกจากนี้ Apigee ยังมีเครื่องมือที่คุณใช้เพื่อทำให้กระบวนการลงทะเบียนนักพัฒนาแอปเป็นแบบอัตโนมัติได้ด้วย ตัวอย่างเช่น
- ใช้ Apigee Edge Management API เพื่อผสานรวมฟังก์ชันการลงทะเบียนเข้ากับ เว็บไซต์ที่มีอยู่ Edge Management API คือ REST API ที่คุณใช้เพื่อดำเนินการทุกขั้นตอน ของกระบวนการลงทะเบียนนักพัฒนาแอปได้ ดูข้อมูลเพิ่มเติมได้ที่การใช้ Edge Management API เพื่อเผยแพร่ API
- ใช้พอร์ทัล Apigee Developer Services เพื่อลงทะเบียนนักพัฒนาแอป พอร์ทัลมีการรองรับการลงทะเบียนนักพัฒนาแอปในตัว แต่ยังมีฟีเจอร์อื่นๆ อีกมากมายเพื่อรองรับ API ของคุณ ดูข้อมูลเพิ่มเติมได้ที่ พอร์ทัลนักพัฒนาแอปคืออะไร
งานที่ 3: ลงทะเบียนแอปของนักพัฒนาแอปใน Edge
แอปต้องลงทะเบียนใน Edge ก่อนจึงจะเข้าถึง API ของคุณได้ อย่างไรก็ตาม มีเพียงนักพัฒนาแอปที่ลงทะเบียนแล้วเท่านั้นที่ลงทะเบียนแอปใน Edge ได้
เมื่อลงทะเบียนแอป นักพัฒนาแอปจะเลือกผลิตภัณฑ์ API อย่างน้อย 1 รายการ ตัวอย่างเช่น คุณอาจเผยแพร่ผลิตภัณฑ์ API หลายรายการที่สอดคล้องกับบริการและแพ็กเกจราคาประเภทต่างๆ จากนั้นนักพัฒนาแอปจะเลือกผลิตภัณฑ์ API ที่มีให้ใช้งานจากรายการได้
เมื่อลงทะเบียนแอปใน Edge แล้ว Edge จะกำหนดคีย์ API ที่ไม่ซ้ำกันให้กับแอป แอป ต้องส่งคีย์ API ดังกล่าวเป็นส่วนหนึ่งของคำขอทุกรายการไปยังทรัพยากร API ระบบจะตรวจสอบสิทธิ์ของคีย์ และ หากคีย์ถูกต้อง ระบบจะอนุมัติคำขอ ในฐานะผู้ให้บริการ คุณสามารถเพิกถอนคีย์ได้ทุกเมื่อ เพื่อไม่ให้แอปเข้าถึง API ของคุณได้อีกต่อไป
ในฐานะผู้ให้บริการ API คุณเป็นผู้กำหนดวิธีลงทะเบียนแอป โดยอาจทำดังนี้
- ใช้กระบวนการด้วยตนเองที่กำหนดให้นักพัฒนาแอปติดต่อองค์กรของคุณเพื่อ ลงทะเบียนแอป จากนั้นคุณจะส่งคีย์ API ให้นักพัฒนาแอป อาจส่งทาง อีเมล
- ใช้ Edge Management API เพื่อผสานรวมฟังก์ชันการลงทะเบียนแอปและการส่งคีย์ เข้ากับเว็บไซต์
- สำหรับบัญชี Edge แบบชำระเงิน ให้ใช้พอร์ทัล Apigee Developer Services ซึ่งมีการรองรับ การลงทะเบียนแอปและการส่งคีย์ API ในตัว
ดูข้อมูลเพิ่มเติมได้ที่ ลงทะเบียนแอปและจัดการคีย์ API คีย์
งานที่ 4: จัดทำเอกสารประกอบสำหรับ API
ข้อควรพิจารณาที่สำคัญสำหรับการเผยแพร่ผลิตภัณฑ์ API คือการจัดทำเอกสารประกอบและกลไกการรับความคิดเห็นจากนักพัฒนาแอป พอร์ทัลนักพัฒนาแอปที่มีฟีเจอร์การเผยแพร่ในโซเชียลมีเดียมีการใช้งานมากขึ้นเรื่อยๆ เพื่อใช้ในการสื่อสารกับชุมชนนักพัฒนาแอป ซึ่งรวมถึงการสื่อสารเนื้อหาแบบคงที่ เช่น เอกสารประกอบของ API และข้อกำหนดในการให้บริการ รวมถึงเนื้อหาแบบไดนามิกที่ชุมชนมีส่วนร่วม เช่น บล็อกและฟอรัม ตลอดจนฟีเจอร์การสนับสนุนลูกค้า
คุณสามารถสร้างเว็บไซต์ของคุณเองเพื่อเผยแพร่เอกสารประกอบ หรือหากมีบัญชี Edge แบบชำระเงิน คุณสามารถใช้พอร์ทัล Apigee Developer Services ได้ พอร์ทัลมีการรองรับเอกสารประกอบ บล็อก ฟอรัม และเนื้อหาประเภทอื่นๆ ที่จำเป็นต่อการสนับสนุนชุมชนนักพัฒนาแอปในตัว
SmartDocs ช่วยให้คุณจัดทำเอกสารประกอบสำหรับ API ในพอร์ทัล Developer Services ใน ลักษณะที่ทำให้เอกสารประกอบของ API มีการโต้ตอบอย่างเต็มรูปแบบ เอกสารประกอบแบบโต้ตอบที่มี SmartDocs หมายความว่าผู้ใช้พอร์ทัลจะทำสิ่งต่อไปนี้ได้
- อ่านเกี่ยวกับ API
- ส่งคำขอแบบเรียลไทม์ไปยัง API
- ดูคำตอบแบบเรียลไทม์ที่ส่งกลับจาก API
ตัวอย่างเช่น รูปต่อไปนี้แสดง API ที่จัดทำเอกสารประกอบในพอร์ทัลโดยใช้ SmartDocs API นี้ให้ข้อมูลสภาพอากาศสำหรับสถานที่ที่เฉพาะเจาะจง
นักพัฒนาแอปป้อนค่าสำหรับพารามิเตอร์การค้นหา "w" เพื่อระบุสถานที่ จากนั้น คลิกปุ่มส่งคำขอ เพื่อดูคำขอและคำตอบแบบเรียลไทม์ การสร้างเอกสารประกอบแบบโต้ตอบสำหรับ API จะช่วยให้ผู้ใช้พอร์ทัลเรียนรู้ ทดสอบ และประเมิน API ของคุณได้ง่าย
Edge Management API คือ REST API ที่ช่วยให้คุณเข้าถึง API Services ได้โดยใช้ไคลเอ็นต์ HTTP ใดก็ได้ Apigee ใช้ SmartDocs เพื่อสร้างเอกสารประกอบแบบโต้ตอบสำหรับ Edge Management API ดูเอกสารประกอบของ API ได้ที่นี่
ดูข้อมูลเพิ่มเติมได้ที่ การใช้ SmartDocs เพื่อจัดทำเอกสารประกอบสำหรับ API