เผยแพร่ API

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

เผยแพร่ API ไปยังพอร์ทัลเพื่อให้นักพัฒนาแอปใช้งานได้ ตามที่อธิบายไว้ในส่วนต่อไปนี้

ภาพรวมของการเผยแพร่ API

กระบวนการเผยแพร่ API ไปยังพอร์ทัลของคุณมี 2 ขั้นตอนดังนี้

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

ข้อมูลที่เผยแพร่ไปยังพอร์ทัลนี้

เมื่อคุณเผยแพร่ API ระบบจะอัปเดตพอร์ทัลของคุณโดยอัตโนมัติ
  • เอกสารอ้างอิง API อินเทอร์เฟซที่มีให้จะขึ้นอยู่กับว่าคุณเผยแพร่ API ของคุณโดยใช้เอกสาร OpenAPI หรือสคีมา GraphQL โปรดดูหัวข้อต่อไปนี้
  • มีการเพิ่มลิงก์ไปยังหน้าข้อมูลอ้างอิงของ API ลงในหน้า API

    หน้า API (รวมอยู่ในพอร์ทัลตัวอย่าง) จะแสดงรายการ API ทั้งหมดที่เผยแพร่ในพอร์ทัลของคุณ โดยแสดงตามลำดับตัวอักษร พร้อมลิงก์ไปยังเอกสารอ้างอิง API ที่เกี่ยวข้องสำหรับข้อมูลเพิ่มเติม นอกจากนี้ คุณยังปรับแต่งสิ่งต่อไปนี้ได้

    • รูปภาพที่แสดงสำหรับการ์ด API แต่ละใบ
    • หมวดหมู่ที่ใช้สำหรับการติดแท็ก API เพื่อให้นักพัฒนาซอฟต์แวร์ค้นพบ API ที่เกี่ยวข้องในหน้า API ได้

    หน้า API ในพอร์ทัลแบบสดที่แสดง 2 หมวดหมู่และการใช้รูปภาพ

    • SmartDocuments (OpenAPI)

    เมื่อคุณเผยแพร่ API โดยใช้เอกสาร OpenAPI ระบบจะเพิ่มเอกสารอ้างอิงของ SmartDocs API ในพอร์ทัล

    นักพัฒนาซอฟต์แวร์จะตรวจสอบเอกสารอ้างอิง API ของ SmartDocuments ของคุณ และใช้แผงลองใช้ API นี้เพื่อส่งคำขอ API และดูเอาต์พุต ลองใช้ API นี้กับปลายทางที่ไม่ปลอดภัยหรือปลายทางที่มีการรักษาความปลอดภัยโดยใช้พื้นฐาน, คีย์ API หรือการตรวจสอบสิทธิ์ OAuth ตามวิธีการรักษาความปลอดภัยที่กำหนดไว้ในเอกสาร OpenAPI สำหรับ OAuth ระบบจะรองรับขั้นตอนต่อไปนี้ รหัสการให้สิทธิ์ รหัสผ่าน และข้อมูลเข้าสู่ระบบไคลเอ็นต์

    หน้าเอกสารอ้างอิง API ที่มีข้อความเสริมที่แสดงวิธีให้สิทธิ์การเรียก API ยกเลิกการวางแผง "ลองใช้ API นี้" ดาวน์โหลดข้อกำหนดที่เกี่ยวข้อง และเรียกใช้ API

    คลิก เพื่อขยายแผง "ลองใช้ API นี้" แผงที่ขยายจะช่วยให้ดูการเรียกใช้ Curl และตัวอย่างโค้ดในรูปแบบต่างๆ เช่น HTTP, Python, Node.js และอื่นๆ ได้ดังที่แสดงด้านล่าง

    ขยาย "ลองใช้แผง API นี้" แล้ว

    โปรแกรมสำรวจกราฟ QL

    เมื่อเผยแพร่ API โดยใช้สคีมา GraphQL ระบบจะเพิ่ม GraphQL Explorer ลงในพอร์ทัลของคุณ GraphQL Explorer คือพื้นที่แบบอินเทอร์แอคทีฟสำหรับการเรียกใช้การค้นหาใน API ของคุณ เครื่องมือสำรวจนี้อิงจาก GraphiQL ซึ่งเป็นการใช้งานอ้างอิงของ GraphQL IDE ที่พัฒนาโดยมูลนิธิ GraphQL

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

    ดูข้อมูลเพิ่มเติมเกี่ยวกับ GraphQL ได้ที่ graphql.org

    GraphQL Explorer ในพอร์ทัล

    ภาพรวมคืออะไร

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

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

    เกี่ยวกับ URL เรียกกลับ

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

    คุณกำหนดค่าได้ว่าจะกำหนดให้ต้องใช้ URL เรียกกลับระหว่างการลงทะเบียนแอปหรือไม่เมื่อเพิ่ม API ลงในพอร์ทัล คุณแก้ไขการตั้งค่านี้ได้ทุกเมื่อ ตามที่อธิบายไว้ในจัดการ URL เรียกกลับสำหรับ API

    เมื่อลงทะเบียนแอป นักพัฒนาแอปต้องป้อน URL เรียกกลับสำหรับ API ทั้งหมดที่จำเป็นต้องใช้ ตามที่อธิบายไว้ในลงทะเบียนแอป

    กำหนดค่าพร็อกซี API ให้รองรับ "ลองใช้ API นี้"

    ก่อนเผยแพร่ API โดยใช้เอกสาร OpenAPI คุณจะต้องกำหนดค่าพร็อกซี API ให้รองรับการส่งคำขอในแผง "ลองใช้ API นี้" ในเอกสารอ้างอิงของ Smartชี้เอกสาร ดังนี้

    • เพิ่มการรองรับ CORS ไปยังพร็อกซี API เพื่อบังคับใช้คำขอแบบข้ามต้นทางฝั่งไคลเอ็นต์

      CORS เป็นกลไกมาตรฐานที่อนุญาตให้เรียกใช้ JavaScript XMLHttpRequest (XHR) ในหน้าเว็บเพื่อโต้ตอบกับทรัพยากรจากโดเมนที่ไม่ใช่ต้นทาง CORS เป็นโซลูชันที่ใช้กันโดยทั่วไปสำหรับ "นโยบายต้นทางเดียวกัน" ซึ่งบังคับใช้โดยเบราว์เซอร์ทั้งหมด

    • อัปเดตการกำหนดค่าพร็อกซี API หากใช้การตรวจสอบสิทธิ์ขั้นพื้นฐานหรือ OAuth2

    ตารางต่อไปนี้สรุปข้อกำหนดในการกำหนดค่าพร็อกซี API เพื่อรองรับแผง "ลองใช้ API นี้" ในเอกสารอ้างอิงของ SmartGoogle API ตามการเข้าถึงการตรวจสอบสิทธิ์

    การเข้าถึงการตรวจสอบสิทธิ์ ข้อกำหนดในการกำหนดค่านโยบาย
    ไม่มีหรือใช้คีย์ API เพิ่มการสนับสนุน CORS ในพร็อกซี API โปรดใช้ตัวอย่างโซลูชัน CORS ที่มีให้ใน GitHub หรือทำตามขั้นตอนที่อธิบายไว้ในการเพิ่มการสนับสนุน CORS ไปยังพร็อกซี API
    การตรวจสอบสิทธิ์พื้นฐาน ทำตามขั้นตอนต่อไปนี้
    1. เพิ่มการสนับสนุน CORS ในพร็อกซี API โปรดใช้ตัวอย่างโซลูชัน CORS ที่มีให้ใน GitHub หรือทำตามขั้นตอนที่อธิบายไว้ในการเพิ่มการสนับสนุน CORS ไปยังพร็อกซี API
    2. ในนโยบาย "Add CORS AssignMessage" ให้ตรวจสอบว่าส่วนหัว Access-Control-Allow-Headers มีแอตทริบิวต์ authorization ตัวอย่างเช่น 
      <Header name="Access-Control-Allow-Headers">
  origin, x-requested-with, accept, content-type, authorization
</Header>
    OAuth2
    1. เพิ่มการสนับสนุน CORS ในพร็อกซี API โปรดใช้ตัวอย่างโซลูชัน CORS ที่มีให้ใน GitHub หรือทำตามขั้นตอนที่อธิบายไว้ในการเพิ่มการสนับสนุน CORS ไปยังพร็อกซี API
    2. ในนโยบาย "Add CORS AssignMessage" ให้ตรวจสอบว่าส่วนหัว Access-Control-Allow-Headers มีแอตทริบิวต์ authorization ตัวอย่างเช่น 
      <Header name="Access-Control-Allow-Headers">
  origin, x-requested-with, accept, content-type, authorization
</Header>
    3. แก้ไขลักษณะการทำงานที่ไม่เป็นไปตามข้อกำหนด RFC ในนโยบาย OAuth2 โปรดใช้ตัวอย่างโซลูชัน OAuth2 ที่ให้ไว้ใน GitHub หรือทำตามขั้นตอนต่อไปนี้
      • ตรวจสอบว่าได้ตั้งค่าองค์ประกอบ <GrantType> ในนโยบาย OAuth2 เป็น request.formparam.grant_type (พารามิเตอร์แบบฟอร์ม) ดูข้อมูลเพิ่มเติมได้ที่ <GrantType>
      • ตรวจสอบว่าได้ตั้งค่า token_type ในนโยบาย OAuth2 เป็น Bearer ไม่ใช่ BearerToken เริ่มต้น

    สำรวจแคตตาล็อก API

    วิธีดูแคตตาล็อก API
    1. เลือกเผยแพร่ > พอร์ทัล แล้วเลือกพอร์ทัลของคุณ
    2. คลิกแคตตาล็อก API ในหน้าแรกของพอร์ทัล
    หรือจะเลือกแคตตาล็อก API ในเมนูแบบเลื่อนลงของพอร์ทัลในแถบนำทางด้านบนก็ได้

    แท็บ API ในแคตตาล็อก API จะแสดงรายการ API ที่เพิ่มลงในพอร์ทัลของคุณ

    แท็บ API ที่แสดงข้อมูลเกี่ยวกับ API รวมถึงชื่อ คำอธิบาย การเปิดเผย หมวดหมู่ ข้อกำหนดที่เกี่ยวข้อง และเวลาที่แก้ไข

    ดังที่ไฮไลต์ไว้ในรูปก่อนหน้านี้ แท็บ API ช่วยให้คุณทำสิ่งต่อไปนี้ได้

    เพิ่ม API ในพอร์ทัล

    วิธีเพิ่ม API ในพอร์ทัล

    1. เข้าถึงแคตตาล็อก API
    2. คลิกแท็บ API หากยังไม่ได้เลือก

    3. คลิก +

      ข้อความเพิ่มผลิตภัณฑ์ API ลงในกล่องโต้ตอบแคตตาล็อกจะปรากฏขึ้น

    4. เลือกผลิตภัณฑ์ API ที่ต้องการเพิ่มลงในพอร์ทัล

    5. คลิกถัดไป
      หน้ารายละเอียด API จะปรากฏขึ้น

    6. กำหนดค่าเนื้อหาเอกสารอ้างอิง API และระดับการเข้าถึงในพอร์ทัลดังนี้

      ฟิลด์ คำอธิบาย
      เผยแพร่แล้วเลือกเผยแพร่เพื่อเผยแพร่ API ไปยังพอร์ทัลของคุณ ยกเลิกการเลือกช่องทำเครื่องหมายหากคุณยังไม่พร้อมที่จะเผยแพร่ API คุณเปลี่ยนการตั้งค่าในภายหลังได้ตามที่อธิบายไว้ในเผยแพร่หรือเลิกเผยแพร่ API ในพอร์ทัล
      ชื่อที่แสดง อัปเดตชื่อ API ที่แสดงในแคตตาล็อก ระบบจะใช้ชื่อผลิตภัณฑ์ API โดยค่าเริ่มต้น คุณเปลี่ยนชื่อที่แสดงในภายหลังได้ ตามที่อธิบายไว้ในแก้ไขชื่อและคำอธิบายที่แสดง
      คำอธิบายการแสดงผล อัปเดตคำอธิบายของ API ที่แสดงในแคตตาล็อก ระบบจะใช้รายละเอียดผลิตภัณฑ์ API โดยค่าเริ่มต้น คุณเปลี่ยนคำอธิบายที่แสดงได้ในภายหลัง ตามที่อธิบายไว้ในหัวข้อแก้ไขชื่อและคำอธิบายที่แสดง
      กำหนดให้นักพัฒนาซอฟต์แวร์ระบุ URL เรียกกลับเปิดใช้หากต้องการให้นักพัฒนาแอประบุ URL เรียกกลับ คุณสามารถเพิ่มหรืออัปเดต URL เรียกกลับในภายหลัง ตามที่อธิบายไว้ในจัดการ URL เรียกกลับสำหรับ API
      เอกสาร API หากต้องการใช้เอกสาร OpenAPI
      1. เลือกเอกสาร OpenAPI
      2. คลิกเลือกเอกสาร
      3. ทำตามขั้นตอนใดขั้นตอนหนึ่งต่อไปนี้
        • คลิกแท็บข้อกำหนดของฉัน และเลือกข้อมูลจำเพาะจากร้านค้าข้อกำหนด
        • คลิกแท็บอัปโหลดไฟล์ แล้วอัปโหลดไฟล์
        • คลิกแท็บนำเข้าจาก URL และนำเข้าข้อกำหนดจาก URL
      4. คลิกเลือก

      วิธีใช้สคีมา GraphQL

      1. เลือกสคีมา GraphQL
      2. คลิกเลือกเอกสาร
      3. เลือกสคีมา GraphQL
      4. คลิกเลือก

      หรืออาจเลือกไม่มีเอกสารประกอบ และเพิ่มเอกสารในภายหลังหลังจากเพิ่ม API แล้ว ตามที่อธิบายไว้ในการจัดการสแนปชอตของเอกสาร

      การเปิดเผย API

      หากยังไม่ได้ลงทะเบียนใช้ฟีเจอร์การจัดการกลุ่มเป้าหมายในรุ่นเบต้า ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้

      • ผู้ใช้ที่ไม่ระบุชื่อเพื่อให้ผู้ใช้ทั้งหมดดู API ได้
      • ผู้ใช้ที่ลงทะเบียนเพื่ออนุญาตให้เฉพาะผู้ใช้ที่ลงทะเบียนดู API ได้

      หากคุณลงทะเบียนใช้ฟีเจอร์การจัดการกลุ่มเป้าหมายในรุ่นเบต้าแล้ว ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้

      • สาธารณะ (ปรากฏแก่ทุกคน) เพื่อให้ผู้ใช้ทั้งหมดดู API ได้
      • ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเพื่ออนุญาตให้ผู้ใช้ที่ลงทะเบียนดู API ได้
      • กลุ่มเป้าหมายที่เลือก เพื่อเลือกกลุ่มเป้าหมายเฉพาะที่คุณต้องการให้สามารถดู API ได้

      คุณจัดการระดับการเข้าถึงกลุ่มเป้าหมายในภายหลังได้ตามที่อธิบายไว้ในจัดการระดับการเข้าถึง API ในพอร์ทัล

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

      เพิ่มหมวดหมู่ที่จะติดแท็ก API เพื่อให้นักพัฒนาแอปค้นพบ API ที่เกี่ยวข้องในหน้า API วิธีระบุหมวดหมู่

      • เลือกหมวดหมู่จากรายการแบบเลื่อนลง
      • เพิ่มหมวดหมู่ใหม่โดยพิมพ์ชื่อหมวดหมู่และกด Enter หมวดหมู่ใหม่จะถูกเพิ่มลงในหน้าหมวดหมู่ และจะแสดงเมื่อเพิ่มหรือแก้ไข API อื่นๆ

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

    จัดการสแนปชอตของเอกสาร

    หลังจากคุณเผยแพร่ API คุณสามารถบันทึกสแนปชอตใหม่ของเอกสาร OpenAPI หรือ GraphQL ได้ทุกเมื่อ เพื่ออัปเดตเอกสารอ้างอิง API ที่เผยแพร่ในพอร์ทัลของคุณ

    ในการจัดการสแนปชอตของเอกสาร ให้ทำดังนี้

    1. เข้าถึงแคตตาล็อก API
    2. คลิกแท็บ API หากยังไม่ได้เลือก
    3. คลิกในแถวของ API ที่ต้องการแก้ไข
    4. ตรวจสอบสถานะสแนปชอต หากข้อมูลไม่เป็นปัจจุบัน ข้อความต่อไปนี้จะแสดงขึ้นมา
      ไอคอนและข้อความที่ระบุภาพรวมไม่เป็นปัจจุบัน
    5. คลิก ไอคอนแก้ไข
    6. ทำงานอย่างใดอย่างหนึ่งต่อไปนี้
      • หากต้องการรีเฟรชภาพรวมของเอกสาร OpenAPI ที่เก่าเกินไป ให้คลิกรีเฟรชสแนปชอต
      • หากต้องการเปลี่ยนเอกสารที่ใช้สร้างเอกสารประกอบสำหรับ API ให้คลิกเลือกเอกสารและเลือกเอกสารใหม่ในส่วนเอกสารประกอบของ API
    7. คลิกบันทึก

    เอกสารอ้างอิง API จะแสดงผลจากเอกสารและเพิ่มลงในหน้าข้อมูลอ้างอิงของ API สถานะสแนปชอตจะอัปเดตเป็น ปัจจุบัน

    ไอคอนและข้อความระบุว่าสแนปชอตเป็นปัจจุบัน

    เผยแพร่หรือเลิกเผยแพร่ API ในพอร์ทัล

    วิธีเผยแพร่หรือเลิกเผยแพร่ API ในพอร์ทัล

    1. เข้าถึงแคตตาล็อก API
    2. คลิกแท็บ API หากยังไม่ได้เลือก
    3. คลิกในแถวของ API ที่ต้องการแก้ไข
    4. คลิก ไอคอนแก้ไข
    5. ในส่วนรายละเอียด API ให้เลือกหรือยกเลิกการเลือกเผยแพร่แล้ว (แสดงอยู่ในแคตตาล็อก) เพื่อเผยแพร่หรือเลิกเผยแพร่ API ในพอร์ทัลตามลำดับ
    6. คลิกบันทึก

    จัดการระดับการเข้าถึง API ในพอร์ทัล

    จัดการระดับการเข้าถึง API ในพอร์ทัลโดยอนุญาตให้เข้าถึงสิ่งต่อไปนี้

    วิธีจัดการระดับการเข้าถึง API ในพอร์ทัล

    1. เข้าถึงแคตตาล็อก API
    2. คลิกแท็บ API หากยังไม่ได้เลือก
    3. คลิกในแถวของ API ที่ต้องการแก้ไข
    4. คลิก ไอคอนแก้ไข
    5. ในส่วน "การเปิดเผย API" ให้เลือกหนึ่งในตัวเลือกต่อไปนี้

    6. เลือกการตั้งค่าระดับการเข้าถึง หากคุณได้ลงทะเบียนใช้ฟีเจอร์กลุ่มเป้าหมายรุ่นเบต้าแล้ว ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้

      • สาธารณะ (ปรากฏแก่ทุกคน) เพื่อให้ผู้ใช้ทุกคนสามารถดูหน้าเว็บได้
      • ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเพื่ออนุญาตให้ผู้ใช้ที่ลงทะเบียนเท่านั้นที่ดูหน้าได้
      • กลุ่มเป้าหมายที่เลือก เพื่อเลือกกลุ่มเป้าหมายเฉพาะที่คุณต้องการให้ดูหน้าได้ ดูจัดการกลุ่มเป้าหมายสำหรับพอร์ทัล
      หรือเลือกตัวเลือกต่อไปนี้
      • ผู้ใช้ที่ไม่ระบุชื่อเพื่อให้ผู้ใช้ทั้งหมดดูหน้าเว็บได้
      • ผู้ใช้ที่ลงทะเบียนเพื่ออนุญาตเฉพาะผู้ใช้ที่ลงทะเบียนเท่านั้นที่ดูหน้าได้

    7. คลิกส่ง

    จัดการ URL เรียกกลับสำหรับ API

    จัดการ URL เรียกกลับสำหรับ API โปรดดูเกี่ยวกับ URL เรียกกลับ

    วิธีจัดการ URL เรียกกลับสำหรับ API

    1. เข้าถึงแคตตาล็อก API
    2. คลิกแท็บ API หากยังไม่ได้เลือก
    3. คลิกในแถวของ API ที่ต้องการแก้ไข
    4. คลิก ไอคอนแก้ไข
    5. ในส่วนรายละเอียด API ให้เลือกหรือยกเลิกการเลือกเผยแพร่แล้ว (แสดงอยู่ในแคตตาล็อก) เพื่อเผยแพร่หรือเลิกเผยแพร่ API ในพอร์ทัลตามลำดับ
    6. คลิกบันทึก

    จัดการรูปภาพสำหรับการ์ด API

    จัดการรูปภาพที่ปรากฏพร้อมกับการ์ด API บนหน้า API ด้วยการเพิ่มหรือเปลี่ยนรูปภาพปัจจุบัน

    วิธีจัดการรูปภาพสำหรับการ์ด API

    1. เข้าถึงแคตตาล็อก API
    2. คลิกแท็บ API หากยังไม่ได้เลือก
    3. คลิกในแถวของ API ที่ต้องการแก้ไข
    4. คลิก ไอคอนแก้ไข

    5. ในส่วนรายละเอียด API ให้ทำดังนี้

      • คลิกเลือกรูปภาพเพื่อเลือกหรืออัปโหลดรูปภาพหากไม่ได้เลือกรูปภาพอยู่ในขณะนี้
      • คลิกเปลี่ยนรูปภาพเพื่อเลือกหรืออัปโหลดรูปภาพอื่น
      • คลิก x ในรูปภาพเพื่อนำออก

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

    ติดแท็ก API โดยใช้หมวดหมู่

    ติดแท็ก API โดยใช้หมวดหมู่ด้วยวิธีใดวิธีหนึ่งต่อไปนี้

    • จัดการหมวดหมู่ที่มีการติดแท็ก API เมื่อแก้ไข API ดังที่อธิบายไว้ด้านล่าง
    • จัดการ API ที่ติดแท็กหมวดหมู่เมื่อแก้ไขหมวดหมู่

    วิธีติดแท็ก API เป็นหมวดหมู่เมื่อแก้ไข API

    1. เข้าถึงแคตตาล็อก API
    2. คลิกแท็บ API หากยังไม่ได้เลือก
    3. คลิกในแถวของ API ที่ต้องการแก้ไข
    4. คลิก ไอคอนแก้ไข
    5. คลิกภายในช่องหมวดหมู่ แล้วทำตามขั้นตอนใดขั้นตอนหนึ่งต่อไปนี้
      • เลือกหมวดหมู่จากรายการแบบเลื่อนลง
      • เพิ่มหมวดหมู่ใหม่โดยพิมพ์ชื่อหมวดหมู่และกด Enter หมวดหมู่ใหม่จะถูกเพิ่มลงในหน้าหมวดหมู่ และจะแสดงเมื่อเพิ่มหรือแก้ไข API อื่นๆ
    6. ทำซ้ำเพื่อติดแท็ก API ในหมวดหมู่อื่นๆ
    7. คลิกบันทึก

    แก้ไขชื่อและคำอธิบายที่แสดง

    วิธีแก้ไขชื่อและคำอธิบายที่แสดง

    1. เข้าถึงแคตตาล็อก API
    2. คลิกแท็บ API หากยังไม่ได้เลือก
    3. คลิกในแถวของ API ที่ต้องการแก้ไข
    4. คลิก ไอคอนแก้ไข
    5. แก้ไขช่องชื่อที่แสดงและคำอธิบายการแสดงตามต้องการ
    6. คลิกบันทึก

    นำ API ออกจากพอร์ทัล

    วิธีนำ API ออกจากพอร์ทัล

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

    จัดการหมวดหมู่ที่ใช้ในการค้นหา API ที่เกี่ยวข้อง

    ติดแท็ก API โดยใช้หมวดหมู่เพื่อให้นักพัฒนาแอปค้นพบ API ที่เกี่ยวข้องในหน้า API ของพอร์ทัลที่เผยแพร่อยู่ เพิ่มและจัดการหมวดหมู่ตามที่อธิบายไว้ในส่วนต่อไปนี้

    สำรวจหน้าหมวดหมู่

    วิธีดูหน้าหมวดหมู่

    1. เลือกเผยแพร่ > พอร์ทัล แล้วเลือกพอร์ทัลของคุณ
    2. คลิกแคตตาล็อก API ในหน้าแรกของพอร์ทัล

      หรือจะเลือกแคตตาล็อก API ในเมนูแบบเลื่อนลงของพอร์ทัลในแถบนำทางด้านบนก็ได้

    3. คลิกแท็บหมวดหมู่

    แท็บหมวดหมู่ในแคตตาล็อก API จะแสดงรายการหมวดหมู่ที่กำหนดไว้สำหรับพอร์ทัลของคุณ

    แท็บหมวดหมู่ที่แสดงชื่อหมวดหมู่ ชื่อ รวมถึงจำนวน API ทั้งหมดที่มอบหมาย

    ตามที่ไฮไลต์ไว้ในรูปก่อนหน้านี้ หน้า API จะช่วยให้คุณทำสิ่งต่อไปนี้ได้

    เพิ่มหมวดหมู่

    เพิ่มหมวดหมู่ด้วยวิธีใดวิธีหนึ่งต่อไปนี้

    หมวดหมู่ใหม่จะถูกเพิ่มลงในหน้าหมวดหมู่ และจะแสดงเมื่อเพิ่มหรือแก้ไข API อื่นๆ

    วิธีเพิ่มหมวดหมู่ด้วยตนเอง

    1. เข้าถึงหน้าหมวดหมู่
    2. คลิก +
    3. ป้อนชื่อหมวดหมู่ใหม่
    4. (ไม่บังคับ) เลือก API อย่างน้อย 1 รายการเพื่อติดแท็กในหมวดหมู่
    5. คลิกสร้าง

    แก้ไขหมวดหมู่

    วิธีแก้ไขหมวดหมู่

    1. เข้าถึงหน้าหมวดหมู่
    2. คลิก
    3. แก้ไขชื่อหมวดหมู่
    4. เพิ่มหรือนำแท็ก API ออก
    5. คลิกบันทึก

    ลบหมวดหมู่

    เมื่อลบหมวดหมู่ แท็ก API ทั้งหมดที่อยู่ในหมวดหมู่นั้นจะถูกลบไปด้วย

    วิธีลบหมวดหมู่

    1. เข้าถึงหน้าหมวดหมู่
    2. วางเคอร์เซอร์เหนือหมวดหมู่ที่คุณต้องการแก้ไขเพื่อแสดงเมนูการทำงาน
    3. คลิก
    4. แก้ไขชื่อหมวดหมู่
    5. เพิ่มหรือนำ API ออก
    6. คลิกบันทึก

    แก้ปัญหาเกี่ยวกับ API ที่เผยแพร่

    ส่วนต่อไปนี้จะให้ข้อมูลเพื่อช่วยคุณแก้ปัญหาข้อผิดพลาดที่เฉพาะเจาะจงกับ API ที่เผยแพร่ของเรา

    ข้อผิดพลาด: ดึงข้อมูลข้อผิดพลาดกลับมาไม่สำเร็จเมื่อใช้ API นี้

    เมื่อใช้ ลองใช้ API นี้ หากระบบแสดงข้อผิดพลาด TypeError: Failed to fetch ให้พิจารณาสาเหตุและวิธีแก้ไขที่เป็นไปได้ต่อไปนี้

    • สำหรับข้อผิดพลาดของเนื้อหาผสม ข้อผิดพลาดอาจเกิดจากปัญหา SPLURAL-UI ที่ทราบ วิธีแก้ปัญหาเบื้องต้นที่เป็นไปได้คือ การตรวจสอบว่าคุณได้ระบุ HTTPS ก่อน HTTP ในคำจำกัดความ schemes ในเอกสาร OpenAPI ของคุณ เช่น

      schemes:
   - https
   - http

    • สำหรับข้อผิดพลาดเกี่ยวกับข้อจำกัดของกลไกการแชร์ทรัพยากรข้ามโดเมน (CORS) โปรดตรวจสอบว่าพร็อกซี API รองรับ CORS CORS เป็นกลไกมาตรฐานที่เปิดใช้คำขอแบบข้ามต้นทางฝั่งไคลเอ็นต์ โปรดดูที่กำหนดค่าพร็อกซี API ให้รองรับ ลองใช้ API นี้

    ข้อผิดพลาด: ส่วนหัว "Access-Control-Allow-Origin" มีหลายค่า "*, *" แต่อนุญาตเพียงค่าเดียว

    เมื่อใช้ "ลองใช้ API นี้" คุณอาจได้รับข้อความแสดงข้อผิดพลาดต่อไปนี้หากมีส่วนหัว Access-Control-Allow-Origin อยู่แล้ว

    The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

    ในการแก้ไขข้อผิดพลาดนี้ ให้แก้ไขนโยบาย AssignMessage เพื่อใช้ <Set> เพื่อตั้งค่าส่วนหัว CORS แทน <Add> ดังที่แสดงในข้อความที่ตัดตอนมาด้านล่าง ดูข้อมูลเพิ่มเติมได้ในบทความของชุมชนที่เกี่ยวข้อง 

    <AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

    ข้อผิดพลาด: ไม่อนุญาตให้มีช่องส่วนหัวของคำขอ

    เมื่อใช้ "ลองใช้ API นี้" หากคุณได้รับข้อผิดพลาด Request header field not allowed ซึ่งคล้ายกับตัวอย่างด้านล่าง คุณอาจต้องอัปเดตส่วนหัวที่รองรับในนโยบาย CORS เช่น

    Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
content-type is not allowed by Access-Control-Allow-Headers in preflight response

    ในตัวอย่างนี้ คุณต้องเพิ่มส่วนหัว content-type ลงในส่วน Access-Control-Allow-Headers ในนโยบาย AssignMessage สำหรับ CORS ตามที่อธิบายไว้ในการแนบนโยบายเพิ่ม CORS กับพร็อกซี API ใหม่

    ข้อผิดพลาด: การเข้าถึงถูกปฏิเสธเมื่อเรียกใช้พร็อกซี API โดยใช้ OAuth2

    นโยบาย OAuthV2 ของ Apigee แสดงการตอบกลับของโทเค็นที่มีพร็อพเพอร์ตี้บางอย่างที่ไม่เป็นไปตามข้อกำหนด RFC เช่น นโยบายจะแสดงผลโทเค็นที่มีค่า BearerToken แทนที่จะเป็นค่า Bearer ซึ่งเป็นไปตามข้อกำหนด RFC ที่คาดไว้ การตอบกลับ token_type ที่ไม่ถูกต้องนี้อาจทำให้เกิดข้อผิดพลาด Access denied เมื่อใช้ ลองใช้ API นี้

    หากต้องการแก้ไขปัญหานี้ ให้สร้างนโยบาย JavaScript หรือ AssignMessage เพื่อเปลี่ยนผลลัพธ์ของนโยบายเป็นรูปแบบที่เป็นไปตามข้อกำหนด ดูข้อมูลเพิ่มเติมได้ที่ลักษณะการทำงานที่ไม่เป็นไปตามข้อกำหนด RFC