เผยแพร่ API

UI

วิธีดูแคตตาล็อก API

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

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

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

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

curl

วิธีแสดงรายการ API

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN"

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
• ACCESS_TOKEN ที่มีโทเค็นการตรวจสอบสิทธิ์ที่ใช้เข้าถึง Apigee Edge API โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และโทเค็นที่หัวข้อตรวจสอบสิทธิ์การเข้าถึง Edge API

ดูหมายเหตุเกี่ยวกับการแบ่งหน้าเพื่อดูวิธีการใช้การแบ่งหน้าในเพย์โหลดการตอบกลับ

เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "one page of apidocs returned",
  "data": [
    {
      "id": 622759,
      "siteId": "my-org-myportal",
      "title": "Test",
      "description": "",
      "published": false,
      "visibility": false,
      "apiId": "apiproducttest18",
      "apiProductName": "apiproduct_test18",
      "edgeAPIProductName": "apiproduct_test18",
      "specId": null,
      "specContent": null,
      "specTitle": null,
      "snapshotExists": false,
      "snapshotModified": null,
      "modified": 1724144471000,
      "anonAllowed": false,
      "imageUrl": null,
      "snapshotState": null,
      "requireCallbackUrl": false,
      "categoryIds": [],
      "specFormat": null,
      "specModified": null,
      "snapshotOutdated": false,
      "snapshotSourceMissing": false,
      "graphqlSchema": null,
      "graphqlEndpointUrl": null,
      "graphqlSchemaDisplayName": null,
      "grpcFileName": null,
      "grpcZipContent": null
    }
  ],
  "code": null,
  "request_id": "1452867334",
  "error_code": null,
  "next_page_token": ""
}

สถานที่:

• modified: เวลาที่มีการแก้ไขรายการแคตตาล็อกครั้งล่าสุดเป็นมิลลิวินาทีนับตั้งแต่เริ่มต้น เช่น 1698165480000
• id: รหัสสินค้าในแคตตาล็อก เช่น 399668

หมายเหตุเกี่ยวกับหน้าเว็บ

• ขนาดหน้า: ใช้ pageSize เพื่อระบุจำนวนรายการในรายการที่จะแสดงในหน้าเดียว ค่าเริ่มต้นคือ 25 และค่าสูงสุดคือ 100 หากมีหน้าเพิ่มเติม ระบบจะป้อนข้อมูล nextPageToken ด้วยโทเค็น ดังนี้

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE" \
     -H "Authorization: Bearer ACCESS_TOKEN"
  

  แทนที่

  • PAGE_SIZE พร้อมจํานวนรายการในลิสต์ที่จะแสดงในหน้าเดียว เช่น 10

  เพย์โหลดคำตอบ

  {
    "status": "success",
    "message": "one page of apidocs returned",
    "data": [
      {
        "id": 638007,
        "siteId": "tsnow-mint-liztest",
        "title": "Testing",
        "description": "",
        "published": false,
        "visibility": false,
        "apiId": "testcatalog",
        "apiProductName": "testcatalog",
        "edgeAPIProductName": "testcatalog",
        "specId": "Petstore",
        "specContent": null,
        "specTitle": null,
        "snapshotExists": true,
        "snapshotModified": 1726508367000,
        "modified": 1728582504000,
        "anonAllowed": false,
        "imageUrl": null,
        "snapshotState": "OK_SUBMITTED",
        "requireCallbackUrl": false,
        "categoryIds": [],
        "specFormat": "YAML",
        "specModified": null,
        "snapshotOutdated": false,
        "snapshotSourceMissing": false,
        "graphqlSchema": null,
        "graphqlEndpointUrl": null,
        "graphqlSchemaDisplayName": null,
        "grpcFileName": null,
        "grpcZipContent": null
      }
    ],
    "code": null,
    "request_id": "1068810934",
    "error_code": null,
    "next_page_token": ""
  }
  

• โทเค็นหน้าเว็บ: ใช้ pageToken เพื่อเรียกข้อมูลหน้าเว็บต่อๆ ไปเมื่อมีมากกว่า 1 หน้า

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN" \
        -H "Authorization: Bearer ACCESS_TOKEN"
  

  แทนที่

  • PAGE_SIZE พร้อมจํานวนรายการในลิสต์ที่จะแสดงในหน้าเดียว เช่น 10
  • PAGE_TOKEN ที่มีค่า nextPageToken เช่น 7zcqrin9l6xhi4nbrb9

UI

วิธีเพิ่ม 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 เลือกเอกสาร OpenAPI คลิกเลือกเอกสาร ทำตามขั้นตอนใดขั้นตอนหนึ่งต่อไปนี้ คลิกแท็บข้อมูลจำเพาะของฉัน แล้วเลือกข้อมูลจำเพาะจาก Store ข้อมูลจำเพาะ คลิกแท็บอัปโหลดไฟล์ แล้วอัปโหลดไฟล์ คลิกแท็บนําเข้าจาก URL และนําเข้าข้อมูลจำเพาะจาก URL คลิกเลือก วิธีใช้สคีมา GraphQL เลือกสคีมา GraphQL คลิกเลือกเอกสาร ไปที่สคีมา GraphQL แล้วเลือกสคีมา คลิกเลือก หรือจะเลือกไม่มีเอกสารประกอบและเพิ่มเอกสารประกอบในภายหลังหลังจากเพิ่ม API แล้วก็ได้ ตามที่อธิบายไว้ในการจัดการภาพรวมของเอกสาร
   ระดับการเข้าถึง API	หากคุณยังไม่ได้ ลงทะเบียนใช้ฟีเจอร์การจัดการกลุ่มเป้าหมายรุ่นเบต้า ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้ ผู้ใช้ที่ไม่ระบุตัวตนเพื่ออนุญาตให้ผู้ใช้ทุกคนดู API ได้ ผู้ใช้ที่ลงทะเบียนเพื่ออนุญาตให้เฉพาะผู้ใช้ที่ลงทะเบียนเท่านั้นที่ดู API ได้ หากคุณได้ ลงทะเบียนใช้ฟีเจอร์การจัดการกลุ่มเป้าหมายรุ่นเบต้าแล้ว ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้ สาธารณะ (ผู้ใช้ทุกคนมองเห็นได้) เพื่ออนุญาตให้ผู้ใช้ทุกคนดู API ได้ ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์เพื่ออนุญาตให้เฉพาะผู้ใช้ที่ลงทะเบียนเท่านั้นที่ดู API ได้ กลุ่มเป้าหมายที่เลือกเพื่อเลือกกลุ่มเป้าหมายที่เฉพาะเจาะจงซึ่งคุณต้องการให้ดู API ได้ คุณจะจัดการระดับการเข้าถึงของกลุ่มเป้าหมายในภายหลังได้ ตามที่อธิบายไว้ในหัวข้อจัดการระดับการเข้าถึงของ API ในพอร์ทัล
   รูปภาพที่ใช้แสดง	หากต้องการแสดงรูปภาพในการ์ด API ในหน้า API ให้คลิกเลือกรูปภาพ ในกล่องโต้ตอบเลือกรูปภาพ ให้เลือกรูปภาพที่มีอยู่ อัปโหลดรูปภาพใหม่ หรือระบุ URL ของรูปภาพภายนอก แล้วคลิกเลือก ดูตัวอย่างภาพปก API แล้วคลิกเลือก คุณสามารถเพิ่มรูปภาพในภายหลังได้ตามที่อธิบายไว้ในหัวข้อจัดการรูปภาพสำหรับการ์ด API เมื่อระบุรูปภาพด้วย URL ภายนอก ระบบจะไม่อัปโหลดรูปภาพไปยังชิ้นงาน นอกจากนี้ การโหลดรูปภาพในพอร์ทัลที่ผสานรวมจะขึ้นอยู่กับความพร้อมใช้งานของรูปภาพ ซึ่งอาจถูกบล็อกหรือจํากัดโดย นโยบายความปลอดภัยของเนื้อหา
   หมวดหมู่	เพิ่มหมวดหมู่ที่จะติดแท็ก API เพื่อให้นักพัฒนาแอปค้นพบ API ที่เกี่ยวข้องในหน้า API วิธีระบุหมวดหมู่ เลือกหมวดหมู่จากรายการแบบเลื่อนลง เพิ่มหมวดหมู่ใหม่โดยพิมพ์ชื่อแล้วกด Enter ระบบจะเพิ่มหมวดหมู่ใหม่ลงในหน้าหมวดหมู่และทำให้พร้อมใช้งานเมื่อเพิ่มหรือแก้ไข API อื่นๆ

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

curl

วิธีเพิ่ม API ไปยังพอร์ทัล

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": "IMAGE_URL",
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
         "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE,
        "apiProductName": "API_PRODUCT"
    }'

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
• ACCESS_TOKEN ที่มีโทเค็นการตรวจสอบสิทธิ์ที่ใช้เข้าถึง Apigee Edge API โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และโทเค็นที่หัวข้อตรวจสอบสิทธิ์การเข้าถึง Edge API
• TITLE ที่มีชื่อที่แสดง เช่น Hello World 2
• DESCRIPTION พร้อมคำอธิบายที่แสดง เช่น Simple hello world example
• ANON_TRUE_OR_FALSE ด้วย true หรือ false (ค่าเริ่มต้น) โดยที่ true หมายความว่า API นี้มีระดับการเข้าถึงแบบสาธารณะและดูแบบไม่ระบุตัวตนได้ มิเช่นนั้นจะมีเพียงผู้ใช้ที่ลงทะเบียนเท่านั้นที่ดูได้
• IMAGE_URL ด้วย URL ของรูปภาพภายนอกที่ใช้สำหรับรายการแคตตาล็อก หรือเส้นทางไฟล์สำหรับไฟล์รูปภาพที่จัดเก็บไว้ในพอร์ทัล เช่น /files/book-tree.jpg เมื่อระบุ URL ของรูปภาพภายนอก ระบบจะไม่อัปโหลดรูปภาพไปยังเนื้อหา นอกจากนี้ การโหลดรูปภาพในพอร์ทัลที่ผสานรวมจะขึ้นอยู่กับความพร้อมใช้งานของรูปภาพ ซึ่งอาจถูกบล็อกหรือจํากัดโดยนโยบายความปลอดภัยของเนื้อหา
• CALLBACK_TRUE_OR_FALSE กับ true หรือ false (ค่าเริ่มต้น) โดยที่ true กำหนดให้ผู้ใช้พอร์ทัลป้อน URL เมื่อจัดการแอป
• CATEGORY_ID ที่มีรหัสของหมวดหมู่ เช่น bf6505eb-2a0f-47af-a00a-ded40ac72960 แยกรหัสหมวดหมู่หลายรหัสด้วยคอมมา รับรหัสหมวดหมู่ด้วยคำสั่งlist API categories
• PUBLISHED_TRUE_OR_FALSE ด้วย true หรือ false (ค่าเริ่มต้น) โดยที่ true ระบุว่า API พร้อมให้บริการแบบสาธารณะ เมื่อเผยแพร่แล้ว คุณสามารถอนุญาตให้เข้าถึงผู้ใช้ทั้งหมด ผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว หรือผู้ใช้บางรายได้
• API_PRODUCT ที่มีชื่อผลิตภัณฑ์ API เช่น Hello World 2

เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "API created",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": false,
    "visibility": false,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729635493000,
    "anonAllowed": false,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": null,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "893346193",
  "error_code": null
}

สถานที่:

• modified: เวลาที่มีการแก้ไขรายการแคตตาล็อกครั้งล่าสุดเป็นมิลลิวินาทีนับตั้งแต่เริ่มต้น เช่น 1698165480000
• id: รหัสสินค้าในแคตตาล็อก เช่น 399668

UI

วิธีแก้ไข API

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

curl

เมื่อเพิ่ม API แล้ว ให้ใช้การเรียกใช้ update เพื่อทำการแก้ไข

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

1. หากต้องการค้นหา id ที่สร้างขึ้นซึ่งระบุ API แต่ละรายการโดยไม่ซ้ำกัน ให้ดูรายการ API ในพอร์ทัลตามที่อธิบายไว้ในสำรวจ API

2. แสดงค่าปัจจุบันของ API ที่เฉพาะเจาะจง

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
   -H "Authorization: Bearer ACCESS_TOKEN"
   

   แทนที่ค่าต่อไปนี้

   • ORG_NAME ด้วยชื่อองค์กร เช่น my-org
   • SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
   • API_DOC พร้อมidของเอกสารที่สร้างขึ้น เช่น 399668 ใช้คําสั่ง list API docs เพื่อค้นหาค่านี้
   • ACCESS_TOKEN ที่มีโทเค็นการตรวจสอบสิทธิ์ที่ใช้เข้าถึง Apigee Edge API โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และโทเค็นที่หัวข้อตรวจสอบสิทธิ์การเข้าถึง Edge API

   เพย์โหลดคำตอบ

   {
     "status": "success",
     "message": "apidoc returned",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": false,
       "visibility": false,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729635493000,
       "anonAllowed": false,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": false,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "601210268",
     "error_code": null
   }
   

1. รวมค่าที่เปลี่ยนแปลงได้ซึ่งคุณต้องการเก็บไว้ในการเรียกใช้ update และแก้ไขค่าที่ต้องการเปลี่ยน หากคุณละเว้นบรรทัด ระบบจะใช้การตั้งค่าเริ่มต้น ในตัวอย่างนี้ ให้เปลี่ยนการตั้งค่าที่เผยแพร่จาก false เป็น true

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "anonAllowed": true,
       "published": true
    }'
   

   แทนที่ค่าต่อไปนี้

   • TITLE ที่มีชื่อที่แสดง เช่น Hello World 2

   เพย์โหลดคำตอบ

   {
     "status": "success",
     "message": "ApiDoc updated",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": true,
       "visibility": true,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729989250000,
       "anonAllowed": true,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": null,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "738172002",
     "error_code": null
   }
   

UI

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

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

curl

ใส่รายการใดรายการหนึ่งต่อไปนี้ในการเรียกใช้การอัปเดต

"published": true,    # API is published to your portal
"published": false,   # API is not published in your portal

วิธีแก้ไข API

1. แสดงค่าปัจจุบัน

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
   -H "Authorization: Bearer ACCESS_TOKEN"

2. ใช้การเรียกใช้ update เพื่อแก้ไข API รวมค่าที่เปลี่ยนแปลงได้ซึ่งคุณต้องการเก็บไว้และแก้ไขค่าที่ต้องการเปลี่ยน หากคุณละเว้นการตั้งค่าที่เปลี่ยนแปลงได้ ระบบจะเขียนทับการตั้งค่านั้นด้วยค่าเริ่มต้น

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/  ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": IMAGE_URL,
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
        "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE
   }

ดูตัวอย่างโดยละเอียดของขั้นตอน ตัวแปร และเพย์โหลดที่แสดงผลได้ที่หัวข้อจัดการเวอร์ชันของเอกสาร

UI

วิธีจัดการระดับการมองเห็นของ API ในพอร์ทัล

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

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

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

6. คลิกส่ง

curl

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

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

ใส่รายการใดรายการหนึ่งต่อไปนี้ในupdate การเรียกใช้

  # When not enrolled in the beta release of the audience management feature:

  "anonAllowed": true,      # Anonymous users can see the API
  "anonAllowed": false,     # Only registered users can see the API

วิธีแก้ไข API

1. แสดงค่าปัจจุบัน

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. ใช้การเรียกอัปเดตเพื่อแก้ไข API รวมค่าที่เปลี่ยนแปลงได้ซึ่งคุณต้องการเก็บไว้ และแก้ไขค่าที่ต้องการเปลี่ยน หากคุณละเว้นการตั้งค่าที่เปลี่ยนแปลงได้ ระบบจะใช้ค่าเริ่มต้น

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ดูตัวอย่างโดยละเอียดของขั้นตอน ตัวแปร และเพย์โหลดที่แสดงผลได้ที่หัวข้อแก้ไข API

UI

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

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

curl

ใส่รายการใดรายการหนึ่งต่อไปนี้ในupdate การเรียกใช้

  "requireCallbackUrl": true,    # Portal user is required to input a URL
  "requireCallbackUrl": false,   # Portal user is not required to input a URL

วิธีแก้ไข API

1. แสดงค่าปัจจุบัน

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. ใช้การเรียกอัปเดตเพื่อแก้ไข API รวมค่าที่เปลี่ยนแปลงได้ซึ่งคุณต้องการเก็บไว้ และแก้ไขค่าที่ต้องการเปลี่ยน หากคุณละเว้นการตั้งค่าที่เปลี่ยนแปลงได้ ระบบจะใช้ค่าเริ่มต้น

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ดูตัวอย่างโดยละเอียดของขั้นตอน ตัวแปร และเพย์โหลดที่แสดงผลได้ที่หัวข้อแก้ไข API

UI

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

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

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

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

   เมื่อระบุรูปภาพ ให้ระบุรูปภาพที่มี URL ภายนอกซึ่งใช้สำหรับสินค้าในแคตตาล็อก หรือเส้นทางสำหรับไฟล์รูปภาพที่จัดเก็บไว้ในพอร์ทัล เช่น /files/book-tree.jpg เมื่อระบุ URL ของรูปภาพภายนอก ระบบจะไม่อัปโหลดรูปภาพไปยังชิ้นงาน นอกจากนี้ การโหลดรูปภาพในพอร์ทัลที่ผสานรวมจะขึ้นอยู่กับความพร้อมใช้งานของรูปภาพ ซึ่งอาจถูกบล็อกหรือจํากัดโดยนโยบายการรักษาความปลอดภัยของเนื้อหา

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

curl

ใส่ข้อมูลต่อไปนี้ในupdatecall

  # Omit line for no image file

  "imageUrl": "IMAGE_URL"    # URL of the external image or name of the image file

วิธีแก้ไข API

1. แสดงค่าปัจจุบัน

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. ใช้การเรียกอัปเดตเพื่อแก้ไข API รวมค่าที่เปลี่ยนแปลงได้ซึ่งคุณต้องการเก็บไว้ และแก้ไขค่าที่ต้องการเปลี่ยน หากคุณละเว้นการตั้งค่าที่เปลี่ยนแปลงได้ ระบบจะใช้ค่าเริ่มต้น

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ดูตัวอย่างโดยละเอียดของขั้นตอน ตัวแปร และเพย์โหลดที่แสดงผลได้ที่หัวข้อแก้ไข API

UI

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

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

curl

ใส่ข้อมูลต่อไปนี้ในupdatecall

  # Omit line for no categories

  "categoryIds": [
      "CATEGORY_ID1",      # A category ID number
      "CATEGORY_ID2"       # A category ID number
    ],

ใช้คำสั่ง list categories เพื่อดูหมายเลขรหัสหมวดหมู่

วิธีแก้ไข API

1. แสดงค่าปัจจุบัน

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. ใช้การเรียกอัปเดตเพื่อแก้ไข API รวมค่าที่เปลี่ยนแปลงได้ซึ่งคุณต้องการเก็บไว้ และแก้ไขค่าที่ต้องการเปลี่ยน หากคุณละเว้นการตั้งค่าที่เปลี่ยนแปลงได้ ระบบจะใช้ค่าเริ่มต้น

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ดูตัวอย่างโดยละเอียดของขั้นตอน ตัวแปร และเพย์โหลดที่แสดงผลได้ที่หัวข้อแก้ไข API

UI

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

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

curl

ใส่ข้อมูลต่อไปนี้ในupdatecall

  "title": "TITLE",    # Display title
  "description": "DESCRIPTION",  # Display description

วิธีแก้ไข API

1. แสดงค่าปัจจุบัน

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. ใช้การเรียกอัปเดตเพื่อแก้ไข API รวมค่าที่เปลี่ยนแปลงได้ซึ่งคุณต้องการเก็บไว้ และแก้ไขค่าที่ต้องการเปลี่ยน หากคุณละเว้นการตั้งค่าที่เปลี่ยนแปลงได้ ระบบจะใช้ค่าเริ่มต้น

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ดูตัวอย่างโดยละเอียดของขั้นตอน ตัวแปร และเพย์โหลดที่แสดงผลได้ที่หัวข้อแก้ไข API

UI

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

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

curl

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

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN"

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
• API_DOC พร้อมidของเอกสารที่สร้างขึ้น เช่น 399668 ใช้คําสั่ง list API docs เพื่อค้นหาค่านี้
• ACCESS_TOKEN ที่มีโทเค็นการตรวจสอบสิทธิ์ที่ใช้เข้าถึง Apigee Edge API โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และโทเค็นที่หัวข้อตรวจสอบสิทธิ์การเข้าถึง Edge API

เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "Apidoc deleted",
  "data": {
  },
  "code": null,
  "request_id": "1790036484",
  "error_code": null
}

UI

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

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

curl

วิธีอัปเดตเนื้อหาเอกสารประกอบ OpenAPI หรือ GraphQL

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"oasDocumentation": {
           "spec":{ "displayName":"DISPLAY_NAME",
                    "contents":"CONTENTS"}
            }
        }'

{
 "status":"success",
 "message":"Api documentation updated",
 "requestId":"645138278"
 "data": {
   "oasDocumentation": {
     "spec": {
        "displayName": "Hello World 2"
      },
     "Format": "YAML"
   }
 }
}

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"graphqlDocumentation": {
         "schema":{"displayName":"DISPLAY_NAME",
         "contents":"CONTENTS"},
         "endpointUri": "ENDPOINT_URI"
          }
      }'

{
"status": "success",
"message": "ApiDocDocumentation updated",
"data": {
  "oasDocumentation": null,
  "graphqlDocumentation": {
    "schema": {
      "displayName": "schema.docs.graphql",
      "contents": ""
    },
    "endpointUri": "https://demo.google.com/graphql"
  }
},
"code": null,
"request_id": "640336173",
"error_code": null
}

UI

curl

วิธีดาวน์โหลดเอกสารประกอบ API โดยใช้ get documentation

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN"

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal

• API_DOC พร้อมidของเอกสารที่สร้างขึ้น เช่น 399668 ใช้คําสั่ง list API docs เพื่อค้นหาค่านี้

  เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "ApiDocDocumentation returned",
  "data": {
    "oasDocumentation": {
      "spec": {
        "displayName": "mock",
        "contents": "b3BlbmFwaTogMy4wLjAKaW5mbzoKICBkZXNjcmlw ..."
      },
      "format": "YAML"
    },
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "269996898",
  "error_code": null
}

สถานที่:

contents: สตริงเนื้อหาของเอกสารประกอบ API ที่เข้ารหัส Base64

UI

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

curl

หากต้องการล้างเนื้อหาที่มีอยู่ ให้ใช้ update API ดังนี้

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
• API_DOC พร้อมidของเอกสารที่สร้างขึ้น เช่น 399668 ใช้คําสั่ง list API docs เพื่อค้นหาค่านี้

เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "ApiDocDocumentation updated",
  "data": {
    "oasDocumentation": null,
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "304329676",
  "error_code": null
}

UI

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

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

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

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

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

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

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

curl

วิธีแสดงหมวดหมู่

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN"

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
• ACCESS_TOKEN ที่มีโทเค็นการตรวจสอบสิทธิ์ที่ใช้เข้าถึง Apigee Edge API โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และโทเค็นที่หัวข้อตรวจสอบสิทธิ์การเข้าถึง Edge API

เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "all ApiCategory items returned",
  "data": [
    {
      "id": "e0518597-ece2-4d7d-ba7c-d1793df0f8db",
      "siteId": "my-org-myportal",
      "name": "My Category"
    },
    {
      "id": "61c1014c-89c9-40e6-be3c-69cca3505620",
      "siteId": "my-org-myportal",
      "name": "test2"
    }
  ],
  "code": null,
  "request_id": "1263510680",
  "error_code": null
}

สถานที่:

• id: รหัสของรายการหมวดหมู่ เช่น 61c1014c-89c9-40e6-be3c-69cca3505620

UI

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

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

curl

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

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
• ACCESS_TOKEN ที่มีโทเค็นการตรวจสอบสิทธิ์ที่ใช้เข้าถึง Apigee Edge API โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และโทเค็นที่หัวข้อตรวจสอบสิทธิ์การเข้าถึง Edge API
• CATEGORY_NAME ที่มีชื่อหมวดหมู่ เช่น demo-backend

เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "API category created",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend"
  },
  "code": null,
  "request_id": "363146927",
  "error_code": null
}

UI

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

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

curl

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

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID"  \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
• CATEGORY_ID ที่มีรหัสของหมวดหมู่ เช่น bf6505eb-2a0f-47af-a00a-ded40ac72960 แยกรหัสหมวดหมู่หลายรหัสด้วยคอมมา รับรหัสหมวดหมู่ด้วยคำสั่งlist API categories
• ACCESS_TOKEN ที่มีโทเค็นการตรวจสอบสิทธิ์ที่ใช้เข้าถึง Apigee Edge API โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และโทเค็นที่หัวข้อตรวจสอบสิทธิ์การเข้าถึง Edge API
• CATEGORY_NAME ที่มีชื่อหมวดหมู่ เช่น demo-backend

เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "ApiCategory updated",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend-test"
  },
  "code": null,
  "request_id": "1976875617",
  "error_code": null
}

UI

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

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

curl

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

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json"

แทนที่ค่าต่อไปนี้

• ORG_NAME ด้วยชื่อองค์กร เช่น my-org
• SITE_ID ที่มีชื่อของพอร์ทัลในรูปแบบ ORG_NAME-PORTAL_NAME โดยที่ ORG_NAME คือชื่อองค์กรและ PORTAL_NAME คือชื่อพอร์ทัลที่แปลงเป็นตัวพิมพ์เล็กทั้งหมดและนำเว้นวรรคและขีดกลางออก เช่น my-org-myportal
• CATEGORY_ID ที่มีรหัสของหมวดหมู่ เช่น bf6505eb-2a0f-47af-a00a-ded40ac72960 รับรหัสหมวดหมู่ด้วยคำสั่ง list API categories
• ACCESS_TOKEN ที่มีโทเค็นการตรวจสอบสิทธิ์ที่ใช้เข้าถึง Apigee Edge API โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และโทเค็นที่หัวข้อตรวจสอบสิทธิ์การเข้าถึง Edge API

เพย์โหลดคำตอบ

{
  "status": "success",
  "message": "ApiCategory deleted",
  "data": {
  },
  "code": null,
  "request_id": "2032819627",
  "error_code": null
}