คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
การเผยแพร่คือกระบวนการทําให้ API พร้อมใช้งานสําหรับนักพัฒนาแอป
วิดีโอ: วิดีโอต่อไปนี้เป็นข้อมูลเบื้องต้นระดับสูงเกี่ยวกับการเผยแพร่ API
การเผยแพร่ API เกี่ยวข้องกับงานต่อไปนี้ตามที่อธิบายไว้ในหัวข้อนี้
- สร้างผลิตภัณฑ์ API ใน Edge ที่รวม API ของคุณ
- ลงทะเบียนนักพัฒนาแอปใน Edge
- ลงทะเบียนแอปของนักพัฒนาแอปใน Edge
- จัดทำเอกสารประกอบและการสนับสนุนชุมชนสำหรับ API
ขั้นตอนที่ 1: สร้างผลิตภัณฑ์ API ใน Edge
งานแรกในการเผยแพร่คือการสร้างผลิตภัณฑ์ API ผลิตภัณฑ์ API คือชุดทรัพยากร API ที่นำเสนอเป็นแพ็กเกจสำหรับนักพัฒนาแอป สร้างผลิตภัณฑ์ API โดยใช้ API หรือ UI การจัดการของ Edge (ดูข้อมูลเพิ่มเติมเกี่ยวกับผลิตภัณฑ์ 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 ที่พร้อมให้บริการได้
ในการตอบสนองต่อการลงทะเบียนแอปใน 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 ใช้ SmartDocs เพื่อสร้างเอกสารประกอบแบบอินเทอร์แอกทีฟสําหรับ Edge Management API ดูเอกสารประกอบของ API ที่นี่
ดูข้อมูลเพิ่มเติมได้ที่การใช้ SmartDocs เพื่อเขียนเอกสารประกอบ API