คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
การเผยแพร่คือกระบวนการทำให้ 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 คุณเป็นผู้เลือกวิธีลงทะเบียนนักพัฒนาซอฟต์แวร์ ตัวอย่างเช่น คุณอาจใช้ขั้นตอนการลงทะเบียนด้วยตนเองที่กำหนดให้นักพัฒนาซอฟต์แวร์ในอนาคตต้องติดต่อองค์กรของคุณเพื่อลงทะเบียน ผู้มีโอกาสเป็นนักพัฒนาซอฟต์แวร์ต้องระบุข้อมูลที่จำเป็นทั้งหมด เช่น อีเมล ชื่อและนามสกุล และชื่อบริษัท หากคุณอนุมัติคำขอของนักพัฒนาซอฟต์แวร์ คุณจะใช้ UI การจัดการ Edge เพื่อลงทะเบียนนักพัฒนาซอฟต์แวร์ด้วยตนเองได้ ดูข้อมูลเพิ่มเติมได้ในการจัดการนักพัฒนาแอป
Apigee คือเครื่องมือที่คุณสามารถใช้เพื่อทำให้ขั้นตอนการลงทะเบียนนักพัฒนาซอฟต์แวร์เป็นไปโดยอัตโนมัติ เช่น
- ใช้ Apigee Edge Management API เพื่อผสานรวมฟังก์ชันการจดทะเบียนกับเว็บไซต์ที่มีอยู่ Edge Management API คือ REST API ซึ่งใช้ดำเนินการลงทะเบียนนักพัฒนาซอฟต์แวร์ในทุกๆ ด้านได้ ดูข้อมูลเพิ่มเติมได้ที่การใช้ Edge Management API เพื่อเผยแพร่ API
- ใช้พอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ Apigee เพื่อลงทะเบียนนักพัฒนาซอฟต์แวร์ พอร์ทัลมีการรองรับการลงทะเบียนนักพัฒนาซอฟต์แวร์ในตัว แต่ยังมีฟีเจอร์อื่นๆ อีกมากมายเพื่อรองรับ API ของคุณ ดูข้อมูลเพิ่มเติมได้ที่พอร์ทัลสำหรับนักพัฒนาซอฟต์แวร์คืออะไร
งานที่ 3: ลงทะเบียนแอปนักพัฒนาซอฟต์แวร์ใน Edge
แอปต้องลงทะเบียนใน Edge ก่อนจึงจะเข้าถึง API ได้ อย่างไรก็ตาม เฉพาะนักพัฒนาซอฟต์แวร์ที่ลงทะเบียนเท่านั้นที่สามารถลงทะเบียนแอปใน Edge ได้
ในขณะลงทะเบียนแอป นักพัฒนาแอปจะเลือกผลิตภัณฑ์ API อย่างน้อย 1 รายการ ตัวอย่างเช่น คุณอาจเผยแพร่ผลิตภัณฑ์ API หลายรายการที่เกี่ยวข้องกับบริการและแผนการตั้งราคาประเภทต่างๆ จากนั้นนักพัฒนาแอปจะสามารถเลือกผลิตภัณฑ์ API ได้จากรายการผลิตภัณฑ์ API ที่มี
เพื่อตอบสนองต่อการลงทะเบียนแอปใน Edge นั้น Edge จะกำหนดคีย์ API ที่ไม่ซ้ำกันให้กับแอป โดยแอปต้องส่งคีย์ API ดังกล่าวเป็นส่วนหนึ่งของคำขอไปยังทรัพยากร API ทุกรายการ คีย์ผ่านการตรวจสอบสิทธิ์แล้ว และคำขอจะได้รับอนุญาตหากถูกต้อง คุณในฐานะผู้ให้บริการสามารถเพิกถอนคีย์ได้ทุกเมื่อเพื่อไม่ให้แอปเข้าถึง API ของคุณอีกต่อไป
ในฐานะผู้ให้บริการ API คุณเป็นผู้เลือกวิธีลงทะเบียนแอป การดำเนินการที่คุณทำได้มีดังนี้
- ใช้กระบวนการที่ดำเนินการด้วยตนเองที่กำหนดให้นักพัฒนาแอปติดต่อองค์กรของคุณเพื่อลงทะเบียนแอป ในการตอบกลับ คุณจะต้องส่งคีย์ API ให้นักพัฒนาแอป โดยอาจส่งทางอีเมล
- ใช้ Edge Management API เพื่อผสานรวมฟังก์ชันการลงทะเบียนแอปและการนำส่งคีย์ลงในเว็บไซต์
- สำหรับบัญชี Edge แบบชำระเงิน ให้ใช้พอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ Apigee ที่มีการรองรับการลงทะเบียนแอปและการนำส่งคีย์ API ในตัว
ดูข้อมูลเพิ่มเติมได้ที่ลงทะเบียนแอปและจัดการคีย์ API
งานที่ 4: บันทึก API ของคุณ
สิ่งสำคัญที่ต้องพิจารณาในการเผยแพร่ผลิตภัณฑ์ API คือการส่งเอกสารและกลไกการแสดงความคิดเห็นให้กับนักพัฒนาซอฟต์แวร์ พอร์ทัลของนักพัฒนาซอฟต์แวร์ที่มีฟีเจอร์การเผยแพร่โซเชียลใช้กันมากขึ้นเพื่อสื่อสารกับชุมชนการพัฒนา ซึ่งรวมถึงการสื่อสารเนื้อหาแบบคงที่ เช่น เอกสารประกอบเกี่ยวกับ API และข้อกำหนดในการใช้งาน รวมถึงเนื้อหาแบบไดนามิกที่จัดทำโดยชุมชน เช่น บล็อกและฟอรัม รวมถึงฟีเจอร์การสนับสนุนลูกค้า
คุณจะสร้างเว็บไซต์ของคุณเองเพื่อทำให้เอกสารประกอบใช้งานได้ หรือหากมีบัญชี Edge แบบชำระเงิน ก็ใช้พอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ Apigee ก็ได้ พอร์ทัลมีการรองรับในตัวสำหรับเอกสารประกอบ บล็อก ฟอรัม และเนื้อหาประเภทอื่นๆ ที่จำเป็นต่อการสนับสนุนชุมชนนักพัฒนาซอฟต์แวร์ของคุณ
SmartDocs ช่วยให้คุณจัดทำเอกสาร API ในพอร์ทัลบริการสำหรับนักพัฒนาแอปได้ในลักษณะที่ทำให้เอกสารประกอบของ API โต้ตอบได้อย่างสมบูรณ์ เอกสารแบบอินเทอร์แอกทีฟที่มี SmartDocs จะช่วยให้ผู้ใช้พอร์ทัลทำสิ่งต่อไปนี้ได้
- อ่านเกี่ยวกับ API
- ส่งคำขอแบบเรียลไทม์ไปยัง API
- ดูการตอบกลับแบบเรียลไทม์ที่ส่งคืนจาก API
ตัวอย่างเช่น รูปต่อไปนี้แสดง API ที่บันทึกไว้ในพอร์ทัลโดยใช้ SmartDocs API นี้ให้ข้อมูลสภาพอากาศสำหรับตำแหน่งเฉพาะ
นักพัฒนาซอฟต์แวร์ป้อนค่าสำหรับพารามิเตอร์การค้นหา "w" เพื่อระบุตำแหน่ง จากนั้น คลิกปุ่มส่งคำขอเพื่อดูคำขอแบบเรียลไทม์และการตอบกลับ การสร้างเอกสารประกอบแบบอินเทอร์แอกทีฟใน API ช่วยให้ผู้ใช้พอร์ทัลเรียนรู้ ทดสอบ และประเมิน API ของคุณได้อย่างง่ายดาย
Edge Management API คือ REST API ที่ช่วยให้คุณเข้าถึงบริการ API โดยใช้ไคลเอ็นต์ HTTP ใดก็ได้ Apigee คือ SmartDocuments ในการสร้างเอกสารประกอบแบบอินเทอร์แอกทีฟสำหรับ Edge Management API ดูเอกสารประกอบเกี่ยวกับ API ได้ที่นี่
ดูข้อมูลเพิ่มเติมได้ที่การใช้ SmartDocs เพื่อสร้างเอกสาร API