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

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

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

ดูวิดีโอต่อไปนี้เพื่อเรียนรู้วิธีสร้างผลิตภัณฑ์ API

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

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

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

Edge

วิธีเข้าถึงหน้าผลิตภัณฑ์ API โดยใช้ Edge UI

  1. ลงชื่อเข้าใช้ https://apigee.com/edge
  2. เลือกเผยแพร่ > ผลิตภัณฑ์ API

หน้าผลิตภัณฑ์ API จะปรากฏขึ้น

หน้าผลิตภัณฑ์ API ที่แสดงรายการผลิตภัณฑ์ API ข้อความไฮไลต์จะแสดงงานที่คุณทำได้โดยแสดงไว้ด้านล่างรูป

ดังที่แสดงในรูปก่อนหน้านี้ หน้าผลิตภัณฑ์ API ช่วยให้คุณทำงานต่อไปนี้ ซึ่งจะอธิบายไว้ภายหลังในส่วนนี้

Classic Edge (Private Cloud)

วิธีเข้าถึงหน้าผลิตภัณฑ์ API โดยใช้ UI แบบคลาสสิกของ Edge

  1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ
  2. เลือกเผยแพร่ > ผลิตภัณฑ์

หน้าผลิตภัณฑ์ API ช่วยให้คุณทำงานต่อไปนี้ได้ ซึ่งจะอธิบายไว้ภายหลังในส่วนนี้

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

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

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

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

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

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

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

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

      ส่วน "เพิ่มทรัพยากร API" จะช่วยให้คุณเพิ่มพร็อกซี API, เส้นทางทรัพยากร หรือทั้ง 2 อย่างได้

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

      โปรดทราบดังต่อไปนี้

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

      เช่น

      ใช้เส้นทางทรัพยากรกับพร็อกซี API ทั้งหมด และละเว้นเส้นทางทรัพยากรที่เจาะจงมากกว่า

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

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

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

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

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

URI คำขอ อนุญาตสำหรับ / อนุญาตสำหรับ /* อนุญาตสำหรับ /** อนุญาตสำหรับ /*/2/** อนุญาตสำหรับ /*/2/*

/v1/weatherapikey

Y

ไม่

ไม่

ไม่

N

/v1/weatherapikey/

Y

ไม่

ไม่

ไม่

N

/v1/weatherapikey/1

Y

Y

ได้

ไม่

N

/v1/weatherapikey/1/

Y

Y

ได้

ไม่

N

/v1/weatherapikey/1/2

Y

ไม่

ได้

ไม่

N

/v1/weatherapikey/1/2/

Y

ไม่

Y

ได้

N

/v1/weatherapikey/1/2/3/

Y

ไม่

Y

Y

Y

/v1/weatherapikey/1/a/2/3/

Y

ไม่

ได้

ไม่

N

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

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

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

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

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

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

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

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

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

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

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

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

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

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