จัดการผลิตภัณฑ์ API

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X info

จัดการผลิตภัณฑ์ API โดยใช้ UI การจัดการของ Apigee Edge ตามที่อธิบายไว้ในส่วนนี้ หากต้องการจัดการผลิตภัณฑ์ API โดยใช้ API โปรดดู การใช้ Edge Management API เพื่อเผยแพร่ API

ดูภาพรวมของผลิตภัณฑ์ API ได้ที่ หัวข้อผลิตภัณฑ์ API คืออะไร

สำรวจหน้าผลิตภัณฑ์ API

เข้าถึงหน้าผลิตภัณฑ์ API ตามที่อธิบายไว้ด้านล่าง

การเพิ่มผลิตภัณฑ์ API

เพิ่มผลิตภัณฑ์ API โดยใช้ UI ตามที่อธิบายไว้ด้านล่าง หากต้องการใช้ Edge API โปรดดู การกำหนดค่าผลิตภัณฑ์ API โดยใช้ API

วิธีเพิ่มผลิตภัณฑ์ API โดยใช้ UI ของ Edge

1. เข้าถึงหน้าผลิตภัณฑ์ API ตามที่อธิบายไว้ก่อนหน้านี้ในส่วนนี้
2. คลิก +ผลิตภัณฑ์ API
3. ป้อนรายละเอียดผลิตภัณฑ์สำหรับผลิตภัณฑ์ API
   

   ช่อง	รายละเอียด
   ชื่อ	ชื่อภายในของผลิตภัณฑ์ API คุณจะแก้ไขชื่อไม่ได้เมื่อสร้างผลิตภัณฑ์ API แล้ว อย่าระบุสัญลักษณ์พิเศษในชื่อ
   ชื่อที่แสดง	ชื่อที่แสดงสำหรับผลิตภัณฑ์ API ชื่อที่แสดงจะใช้ใน UI และคุณแก้ไขได้ทุกเมื่อ หากไม่ได้ระบุ ระบบจะใช้ค่าชื่อ ระบบจะป้อนข้อมูลในช่องนี้โดยอัตโนมัติโดยใช้ค่าชื่อ คุณสามารถแก้ไขหรือลบเนื้อหาได้ ชื่อที่แสดงอาจมีสัญลักษณ์พิเศษ
   คำอธิบาย	คำอธิบายของผลิตภัณฑ์ API
   สภาพแวดล้อม	สภาพแวดล้อมที่ผลิตภัณฑ์ API จะอนุญาตให้เข้าถึง เช่น test หรือ prod
   การเข้าถึง	ระดับการเข้าถึง ดูรายละเอียดได้ที่ ระดับการเข้าถึง
   อนุมัติคำขอเข้าถึงโดยอัตโนมัติ	เปิดใช้การอนุมัติคำขอคีย์สำหรับผลิตภัณฑ์ API นี้จากแอปใดก็ได้โดยอัตโนมัติ หากต้องการกำหนดให้มีการอนุมัติคีย์ด้วยตนเอง ให้ปิดใช้ตัวเลือกนี้ ดู การลงทะเบียนแอปและการจัดการคีย์ API (UI) และ คีย์แอปของนักพัฒนาแอป (API)
   Quota	ขีดจำกัดโควต้าที่คุณต้องการอ้างอิงจากนโยบายโควต้า การป้อนค่าโควต้าไม่ได้บังคับใช้ข้อจำกัดเกี่ยวกับจำนวนการโทรที่สามารถทำได้ผ่านผลิตภัณฑ์โดยอัตโนมัติ พร็อกซี API ที่ผลิตภัณฑ์อ้างอิงต้องมีนโยบายโควต้าเพื่อบังคับใช้โควต้า ดูข้อมูลเพิ่มเติมได้ที่โควต้า
   ขอบเขต OAuth ที่อนุญาต	หากคุณใช้ OAuth กับผลิตภัณฑ์ API ขอบเขต OAuth ที่อนุญาตซึ่งคุณต้องการให้ผลิตภัณฑ์ API อนุญาต (เช่น ขอบเขตการอ่านหรือขอบเขตอื่นๆ ที่แอปจะส่งไปพร้อมกับการเรียก API) ระบุขอบเขตหลายรายการเป็นรายการที่คั่นด้วยคอมมา ดูขอบเขต OAuth

4. เพิ่มทรัพยากร API ที่พร้อมใช้งานในผลิตภัณฑ์ API ซึ่งรวมถึงพร็อกซี API และเส้นทางทรัพยากร

   ตัวอย่างเช่น หากคุณเพิ่มพร็อกซี API "music" ลงในผลิตภัณฑ์ที่มีเส้นทางฐานเป็น /music ผลิตภัณฑ์ API จะอนุญาตการเรียกไปยัง /music อย่างไรก็ตาม หากคุณต้องการให้ผลิตภัณฑ์ API อนุญาตการเข้าถึงเฉพาะเส้นทางทรัพยากร venues ซึ่งมี URI เป็น /music/venues ให้เพิ่มเส้นทางทรัพยากร /venues ลงในผลิตภัณฑ์ ในกรณีนี้ ระบบจะอนุญาตการเรียกไปยัง /music/venues?name=paramount แต่จะบล็อกการเรียกไปยัง /music/artists?name=Jack%Johnson

   ตั้งค่าเส้นทางทรัพยากรที่เฉพาะเจาะจง หรือตั้งค่าเส้นทางฐานและเส้นทางย่อยที่เป็นไปได้ทั้งหมดโดยระบุเส้นทางทรัพยากรเป็น / เส้นทางทรัพยากรอาจมีไวลด์การ์ด /** และ /* ไวลด์การ์ดดอกจันคู่ระบุว่าระบบรองรับเส้นทางย่อยทั้งหมดของเส้นทางฐาน (แต่ไม่รองรับเส้นทางฐาน) ดอกจันเดี่ยวระบุว่าระบบรองรับเฉพาะ URI ที่อยู่ระดับต่ำกว่าเส้นทางฐาน 1 ระดับ ดู การกำหนดค่าลักษณะการทำงานของเส้นทางทรัพยากร '/', '/*' และ '/**' ตามที่อธิบายไว้ในส่วนนี้

   วิธีเพิ่มทรัพยากร API

   1. คลิกเพิ่มพร็อกซี หรือเพิ่มเส้นทาง ในส่วนทรัพยากร API
   2. เลือกว่าคุณต้องการเพิ่มพร็อกซี API เส้นทาง หรือทั้งพร็อกซี API และเส้นทาง

      

   3. เพิ่มพร็อกซี API และเส้นทางทรัพยากรอย่างน้อย 1 รายการ

      ข้อควรทราบ

      • เส้นทางทรัพยากรที่คุณกำหนดจะมีผลกับพร็อกซี API ทั้งหมดที่เพิ่มลงในผลิตภัณฑ์ API
      • เส้นทางทรัพยากรที่ครอบคลุมมากกว่าและมีความเฉพาะเจาะจงน้อยกว่าจะมีลำดับความสำคัญสูงกว่าเส้นทางทรัพยากรที่มีความเฉพาะเจาะจงมากกว่า เช่น หากคุณเพิ่ม / และ /** เส้นทางทรัพยากร / จะมีลำดับความสำคัญสูงกว่า ระบบจะละเว้นเส้นทางทรัพยากร /**

      ตัวอย่างเช่น

      

   4. คลิกเพิ่ม หรือเพิ่มและเริ่มรายการอื่น (เพื่อระบุทรัพยากร API เพิ่มเติม)
5. (ไม่บังคับ) ใช้ส่วนเป้าหมายบริการระยะไกลของ Apigee เพื่อผูกผลิตภัณฑ์กับเป้าหมายบริการระยะไกลอย่างน้อย 1 รายการ คุณสามารถละเว้นการตั้งค่านี้ได้ เว้นแต่จะใช้ Apigee Envoy Adapter ดูข้อมูลเพิ่มเติมได้ที่คู่มือการใช้งานสำหรับ Apigee Envoy Adapter

6. (ไม่บังคับ) ใช้ส่วนแอตทริบิวต์ที่กำหนดเอง เพื่อเพิ่มแอตทริบิวต์ที่กำหนดเองได้สูงสุด 18 รายการลงในผลิตภัณฑ์ API

   แอตทริบิวต์ที่กำหนดเองคือคู่คีย์/ค่าที่ใช้ได้หลายวิธี รวมถึงช่วยควบคุมการดำเนินการของพร็อกซี API ตัวอย่างเช่น คุณสร้างแอตทริบิวต์ที่กำหนดเองชื่อ deprecated ที่มีค่าเป็นจริงหรือเท็จได้ ในโฟลว์พร็อกซี API คุณสามารถ ตรวจสอบค่าแอตทริบิวต์ deprecated ของผลิตภัณฑ์ API (เช่น ใช้ตัวแปร verifyapikey.{policy_name}.apiproduct.deprecated ซึ่งจะพร้อมใช้งานโดยอัตโนมัติหลังจากที่คุณสร้างแอตทริบิวต์ที่กำหนดเอง) หากค่าเป็นจริง (เลิกใช้งานแล้ว) คุณจะแสดงข้อผิดพลาดด้วยนโยบาย Raise Fault ได้

7. คลิกบันทึก

การกำหนดค่าลักษณะการทำงานของเส้นทางทรัพยากร '/', '/*' และ '/**'

ตารางต่อไปนี้อธิบายลักษณะการทำงานเริ่มต้นของผลิตภัณฑ์ API สำหรับ เส้นทางทรัพยากร ต่างๆ ในตัวอย่างนี้ พร็อกซี API มีเส้นทางฐานเป็น /v1/weatherapikey เส้นทางทรัพยากรของผลิตภัณฑ์ API จะมีผลกับคำต่อท้ายเส้นทางหลังจาก เส้นทางฐาน

URI คำขอ	อนุญาตสำหรับ /	อนุญาตสำหรับ /*	อนุญาตสำหรับ /**	อนุญาตสำหรับ /*/2/**	อนุญาตสำหรับ /*/2/*
/v1/weatherapikey	ได้	ไม่	ไม่	ไม่	ไม่ได้
/v1/weatherapikey/	ได้	ไม่	ไม่	ไม่	ไม่ได้
/v1/weatherapikey/1	ได้	ได้	ได้	ไม่	ไม่ได้
/v1/weatherapikey/1/	ได้	ได้	ได้	ไม่	ไม่ได้
/v1/weatherapikey/1/2	ได้	ไม่	ได้	ไม่	ไม่ได้
/v1/weatherapikey/1/2/	ได้	ไม่	ได้	ได้	ไม่ได้
/v1/weatherapikey/1/2/3/	ได้	ไม่	ได้	ได้	ได้
/v1/weatherapikey/1/a/2/3/	ได้	ไม่	ได้	ไม่	ไม่ได้

โดยค่าเริ่มต้น เส้นทางทรัพยากร / ในผลิตภัณฑ์ API จะรองรับเส้นทางฐานและเส้นทางย่อยทั้งหมด เช่น หากเส้นทางฐานของ พร็อกซี API คือ /v1/weatherapikey ผลิตภัณฑ์ API จะรองรับคำขอไปยัง /v1/weatherapikey และเส้นทางย่อยใดก็ตาม เช่น /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA และอื่นๆ

คุณสามารถเปลี่ยนค่าเริ่มต้นนี้เพื่อให้เส้นทางทรัพยากร / สอดคล้องกับเส้นทางฐานของพร็อกซี API เท่านั้น ซึ่งหมายความว่าผลิตภัณฑ์ API จะไม่อนุญาตการเข้าถึง URI ที่มีสิ่งใดก็ตามอยู่หลัง / หากคุณทำการเปลี่ยนแปลงนี้ ในตารางด้านบน เฉพาะ 2 แถวแรกในส่วน "อนุญาตสำหรับ /" เท่านั้นที่จะมี "ได้"

หากต้องการเปลี่ยนค่าเริ่มต้น ผู้ดูแลระบบต้องตั้งค่าพร็อพเพอร์ตี้ features.isSingleForwardSlashBlockingEnabled ในองค์กรเป็น true ลูกค้า Cloud สามารถส่งคำขอดังกล่าว ไปยัง ทีมสนับสนุนของ Apigee Edge ได้

การแก้ไขผลิตภัณฑ์ API

วิธีแก้ไขผลิตภัณฑ์ API

1. เข้าถึงหน้าผลิตภัณฑ์ API ตามที่อธิบายไว้ก่อนหน้านี้ในส่วนนี้
2. คลิก ในแถวของผลิตภัณฑ์ API ที่คุณต้องการแก้ไข
3. คลิกแก้ไข ในหน้าผลิตภัณฑ์ API
4. แก้ไขช่องตามที่ต้องการ

   คุณสามารถลบทรัพยากรที่เพิ่มลงในผลิตภัณฑ์ API ได้ คุณอาจต้องการดำเนินการนี้หากทรัพยากรทำงานผิดปกติหรือต้องมีการพัฒนาเพิ่มเติม เมื่อลบแล้ว ทรัพยากรดังกล่าวจะไม่เป็นส่วนหนึ่งของผลิตภัณฑ์ API อีกต่อไป แอปใดก็ตามที่ใช้ผลิตภัณฑ์ API จะเข้าถึงทรัพยากรที่ลบ ไม่ได้อีกต่อไป ระบบจะนำทรัพยากรที่ลบออกจากผลิตภัณฑ์ แต่จะไม่ลบออกจากระบบ ดังนั้น ผลิตภัณฑ์อื่นๆ จึงยังคงใช้ทรัพยากรดังกล่าวได้

5. คลิกบันทึก

สำหรับ Apigee Edge for Public Cloud นั้น Edge จะเก็บ เอนทิตีต่อไปนี้ไว้ในแคชเป็นเวลาอย่างน้อย 180 วินาทีหลังจากที่ เข้าถึงเอนทิตี

• โทเค็นเพื่อการเข้าถึง OAuth ซึ่งหมายความว่าโทเค็นที่เพิกถอนแล้วอาจยังคงใช้งานได้นานถึง 3 นาทีจนกว่าขีดจำกัดแคชจะหมดอายุ
• เอนทิตีของบริการการจัดการคีย์ (KMS) (แอป นักพัฒนาแอป ผลิตภัณฑ์ API)
• แอตทริบิวต์ที่กำหนดเองในโทเค็น OAuth และเอนทิตี KMS

การลบผลิตภัณฑ์ API

คุณต้องยกเลิกการลงทะเบียน/ยกเลิกการเชื่อมโยงแอปของนักพัฒนาแอปที่เชื่อมโยงกับผลิตภัณฑ์ก่อนจึงจะลบผลิตภัณฑ์ API ได้ คุณทำได้โดยลบแอป หรือ เพิกถอนคีย์ API ของแอป

วิธีลบผลิตภัณฑ์ API

1. เข้าถึงหน้าผลิตภัณฑ์ API ตามที่อธิบายไว้ก่อนหน้านี้ในส่วนนี้
2. วางเคอร์เซอร์เหนือผลิตภัณฑ์ API ในรายการ
3. คลิก
4. คลิกลบ เพื่อยืนยันการดำเนินการลบ