การใช้ SmartDocs เพื่อจัดเก็บ API

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

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

• อ่านเกี่ยวกับ API ของคุณ
• ส่งคำขอแบบเรียลไทม์ไปยัง API ของคุณ
• ดูการตอบกลับแบบเรียลไทม์จาก API

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

Edge Management API คือ RESTful API ที่ช่วยให้คุณเข้าถึงบริการ API โดยใช้ ไคลเอ็นต์ HTTP Apigee ใช้ Smartdocs เพื่อสร้างเอกสารแบบอินเทอร์แอกทีฟสำหรับการจัดการ Edge API โปรดดูเอกสารประกอบของ API ดังกล่าวที่นี่

ตัวอย่างพอร์ทัล Smartdocs

หากต้องการใช้ SmartDocuments คุณต้องมีพอร์ทัล Apigee Developer Services สำหรับข้อมูลเพิ่มเติม โปรดดู การสร้างนักพัฒนาซอฟต์แวร์ พอร์ทัล

จากหน้าแรกของพอร์ทัลนักพัฒนาซอฟต์แวร์ ให้คลิก API ในแถบนำทางด้านบนเพื่อ ดูหน้าเอกสารประกอบของ API

มีการบันทึก API อยู่ 2 แบบในพอร์ทัล ได้แก่ Hello World และตัวอย่างสำหรับสัตว์เลี้ยง

Hello World API สร้างขึ้นจาก OpenAPI เป้าหมายจำลอง ข้อกำหนด mocktarget.yaml ดูข้อมูลเพิ่มเติมได้ที่ https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi

Pet Store Example API สร้างขึ้นจากเดโมเกี่ยวกับร้านขายสัตว์เลี้ยงแบบคลาสสิก

สำรวจ Hello World API

1. คลิก Hello World API หน้าข้อมูลสรุปของ Hello World API มีดังนี้
   วันที่
2. คลิกดูการยืนยัน API SmartDocuments สำหรับทรัพยากรนี้คือ แสดง:
   วันที่
3. คลิกส่งคำขอนี้
4. ดูการตอบกลับ:

   HTTP/1.1 200 OK
   Connection:
   keep-alive
   Content-Length:
   18
   Content-Type:
   text/html; charset=utf-8
   Date:
   Tue, 21 Jun 2016 21:49:32 GMT
   ETag:
   W/"12-Jb9QP1bUxNSmZkxQGt5KLQ"
   X-Powered-By:
   Apigee
   <H2>I <3 APIs</H2>
   

5. คลิกแท็บคำขอเพื่อดูคำขอ หรือ cURL เพื่อดูการเรียก cURL ที่เกี่ยวข้อง

วิธีบันทึก API โดยใช้ Smartdocs

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

ขั้นตอนทั่วไปที่คุณปฏิบัติตามเพื่อใช้ SmartDocuments มีดังนี้

1. กำหนดค่าโมดูล Drupal SmartDocuments ในพอร์ทัล
2. สร้างรูปแบบ SmartDocuments
3. เพิ่ม API ไปยังโมเดลจากไฟล์ WADL (ชื่อเดิม Swagger) ข้อกำหนดเฉพาะ หรือด้วยตนเอง
4. แสดงผลโมเดลเป็นคอลเล็กชันของโหนด Drupal โหนด Drupal แต่ละโหนด มีข้อมูลเกี่ยวกับ API เดียว ตัวอย่างเช่น หากทรัพยากรใน API รองรับทั้ง โดย SmartDOC จะสร้างโหนด Drupal แยกต่างหากสำหรับ POST และ PUT
5. เผยแพร่โหนด Drupal เมื่อเผยแพร่แล้ว ผู้ใช้พอร์ทัลสามารถดูและ โต้ตอบกับ API ของคุณ
6. แก้ไขโหนด Drupal ก่อนหรือหลังจากเผยแพร่ คุณสามารถ แก้ไขโหนด Drupal โดยใช้โปรแกรมแก้ไข Drupal หรือโดยการแก้ไขไฟล์ WADL ต้นฉบับ หรือ ข้อกำหนดของ OpenAPI เมื่อแก้ไขไฟล์ WADL หรือข้อมูลจำเพาะของ OpenAPI เสร็จแล้ว ให้นำเข้า กลับเข้าไปในโมเดลเป็นการแก้ไขใหม่ จากนั้นแสดงผลและเผยแพร่การเปลี่ยนแปลงของคุณ
7. เปิดใช้งาน TLS เนื่องจาก SmartDocuments ส่งข้อมูลรับรองการตรวจสอบสิทธิ์ไปที่ แบ็กเอนด์เพื่อเป็นส่วนหนึ่งของการส่งคำขอไปยัง API ของคุณ คุณควรเปิดใช้ TLS ในพอร์ทัลเพื่อ ตรวจสอบว่าข้อมูลเข้าสู่ระบบเหล่านั้นปลอดภัย ในสภาพแวดล้อมการใช้งานจริงและการทดสอบของพอร์ทัล Apigee จะมีใบรับรอง TLS ที่ต้องใช้ในการสร้างคำขอ https:// แต่ก่อนที่คุณจะไป แบบสดกับพอร์ทัลของคุณ คุณต้องรับใบรับรอง TLS ของคุณเองและเปิดใช้ TLS ดูข้อมูลเพิ่มเติมได้ที่ การใช้ TLS ใน พอร์ทัล

เกี่ยวกับรูปแบบและเทมเพลต SmartDoc

เมื่อคุณสร้างโมเดลในพอร์ทัล ระบบจะเก็บโมเดลไว้ใน Edge ขององค์กร ไม่ใช่ใน Drupal โมเดลคือบล็อกขนาดใหญ่ของ JSON ที่มีชื่อภายใน (เช่น "my-smartdocs-api") และกำหนดโครงสร้างของ API ในทางกลับกัน พอร์ทัลของคุณ จะแสดงผลโมเดลใน HTML และให้อินเทอร์เฟซการแก้ไขสำหรับโมเดล การอัปเดต API ในพอร์ทัลจะถูกส่งคืนไปยังโมเดลต้นทางโดยอัตโนมัติ

จัดเก็บไว้ในองค์กร	จัดเก็บไว้ใน Drupal
รุ่น	เทมเพลต โหนด Drupal ที่มีฟังก์ชันการแก้ไข

สมมติว่าคุณมีพอร์ทัลหลายตัวในองค์กร (เช่น dev, ขั้นตอน และ เวอร์ชันที่ใช้งานจริง) ใน Pantheon คุณจะย้ายพอร์ทัลจากสภาพแวดล้อมหนึ่งไปยังอีกสภาพแวดล้อมหนึ่งได้ อินสแตนซ์แต่ละรายการของ ดูเหมือนว่าพอร์ทัลจะมีโมเดลของตัวเอง แต่ทุกพอร์ทัลอ้างอิงแหล่งที่มาจริงๆ โมเดล หากคุณแก้ไข API ในเวอร์ชันที่กำลังพัฒนา โมเดลจะได้รับการอัปเดต และการเปลี่ยนแปลงจะปรากฏในเวอร์ชันที่ใช้งานจริง และเช่นเดียวกัน หากคุณลบโมเดลใน dev ระบบจะลบแหล่งที่มาและโมเดลนั้นไม่มีอยู่ใน เวอร์ชันที่ใช้งานจริง

เทมเพลตจะควบคุมรูปลักษณ์ของ SmartDocuments และเทมเพลตเหล่านั้น (อยู่ภายใต้ แฮนเดิลและไฟล์ CSS) จะจัดเก็บไว้กับอินสแตนซ์พอร์ทัลแต่ละรายการ ในทางทฤษฎี แต่ละพอร์ทัล ใช้เทมเพลตที่ไม่ซ้ำกันสำหรับแต่ละโมเดล อย่างไรก็ตาม ความสะดวกสบายอย่างหนึ่งของเฟรมเวิร์กการแสดงผล คือเทมเพลตเริ่มต้น (ค่าเริ่มต้นของ Apigee หรือเทมเพลตที่คุณระบุ) โดยอัตโนมัติ ที่ใช้กับแต่ละโมเดล

แผนภาพต่อไปนี้แสดงความสัมพันธ์ระหว่างโมเดลและพอร์ทัล ลูกศรสีเขียวแสดงขึ้น การซิงค์อัตโนมัติ

คำสั่ง cURL ต่อไปนี้จะแสดงโมเดลทั้งหมดในองค์กร

curl -v https://api.enterprise.apigee.com/v1/o/{your_org}/apimodels/ -u edge_org_admin@example.com

การกำหนดค่าโมดูล SmartDocuments

Apigee ได้ใช้ SmartDocuments เป็นโมดูล Drupal ที่กำหนดเอง ใช้ขั้นตอนต่อไปนี้เพื่อ กำหนดค่าโมดูล SmartDocuments

วิธีกำหนดค่าโมดูล Smartเอกสาร

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก Modules ในเมนูการดูแลระบบของ Drupal รายการทั้งหมด โมดูล Drupal ที่ติดตั้งไว้จะปรากฏขึ้น
3. เปิดใช้โมดูล SmartDocs
4. บันทึกการกำหนดค่า
5. เลือก Modules ในเมนูผู้ดูแลระบบ Drupal
6. เลือก SmartDocuments -> สิทธิ์และตรวจสอบว่า "ดำเนินการดูแลระบบ งานสำหรับโมดูล SmartGoogle เอกสาร" สำหรับ "ผู้ดูแลระบบ" เปิดใช้แล้ว
7. เลือกการกำหนดค่า > พอร์ทัลนักพัฒนาซอฟต์แวร์ในการดูแลระบบ Drupal เมนู
8. ตั้งค่าระยะหมดเวลาของการเชื่อมต่อและระยะหมดเวลาของคำขอเป็น 16 วินาที
9. บันทึกการกำหนดค่า
10. กำหนดการตั้งค่า URL
    1. เลือกการกำหนดค่า > การค้นหาและข้อมูลเมตา > ชื่อแทน URL > การตั้งค่าจากเมนู Drupal
    2. ตั้งค่าความยาวชื่อแทนสูงสุดและคอมโพเนนต์สูงสุด length เป็น 255
    3. ขยายเครื่องหมายวรรคตอน
    4. สำหรับวงเล็บปีกกาเปิด ({) และวงเล็บปีกกาปิด (}) การตั้งค่า ให้เลือกไม่มีการดำเนินการ (อย่าแทนที่)
    5. คลิก Save Configuration
11. หากพอร์ทัลนักพัฒนาซอฟต์แวร์ของคุณแสดงต่อผู้ใช้ในเครือข่ายภายในโดยที่ไม่สามารถเข้าถึง อินเทอร์เน็ต หรือหากชุดย่อยของ API อยู่ในเครือข่ายส่วนตัว ให้กำหนดค่า SmartDocuments API URL ของพร็อกซี ดังนี้
    1. เลือกการกำหนดค่า > SmartDocuments ในองค์การ Drupal เมนู
    2. ขยายการตั้งค่าขั้นสูง
    3. อัปเดตช่อง URL ของพร็อกซี SmartDocuments ดังนี้ <host>/smartdocs/v1/sendrequest
       ความช่วยเหลือแบบในหน้าควรระบุค่าที่จำเป็นสำหรับสภาพแวดล้อมของคุณ ตัวอย่างเช่น
       https://api-us-east-1-enterprise.apigee.com/smartdocs/v1/sendrequest
       
       ช่องนี้จะมีค่าเริ่มต้นเป็น https://apiconsole-prod.apigee.net/smartdocs/v1/sendrequest
    4. คลิก Save Configuration

กำลังสร้างโมเดล

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

แต่ละโมเดลระบุชื่อภายในที่ไม่ซ้ำกันซึ่งกำหนด URL พื้นฐานของฟิลด์ โหนด Drupal ที่สร้างขึ้น URL ของโหนด Drupal แต่ละโหนดจะอยู่ในรูปแบบดังนี้

http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>

โดยมี

• drupalBasePath: URL ฐานของพอร์ทัล
• internalName: ชื่อภายในของโมเดล
• httpMethod: เมธอด HTTP ของ API เช่น get, insert, post หรือ ลบ
• resourcePath: เส้นทางทรัพยากร

ตัวอย่างเช่น หากคุณระบุชื่อภายในเป็น "mymodel" URL สำหรับเครือข่ายที่สร้างขึ้น โหนด Drupal สำหรับคำขอ GET ไปยังทรัพยากรชื่อ "/books" คือ

http://prod-myco.devportal.apigee.com/mymodel/apis/get/books

วิธีสร้างโมเดล

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

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ในการดูแลระบบ Drupal เมนู
3. เลือกรูปแบบใหม่ที่ด้านบนของหน้า
4. ป้อนข้อมูลในช่องต่อไปนี้
   • ชื่อ: ชื่อโมเดลที่จะแสดงทั่วทั้งเว็บไซต์
   • ชื่อภายใน: ขณะที่คุณพิมพ์ชื่อ ฟิลด์ ชื่อที่แสดง ชื่อภายในของโมเดลซึ่งต้องไม่ซ้ำกันในโมเดลทั้งหมด ชื่อภายในต้องประกอบด้วยตัวอักษรพิมพ์เล็ก ตัวเลข และขีดกลางเท่านั้นโดยไม่มีช่องว่าง เลือกแก้ไขเพื่อแก้ไขชื่อนี้
   • คำอธิบาย: คำอธิบายโมเดล
5. เลือกสร้างโมเดล

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

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

การเพิ่ม API ให้กับโมเดล

คุณสามารถเพิ่ม API ให้กับโมเดลได้โดยดำเนินการดังนี้

• การนำเข้าไฟล์ WADL ที่มีการกำหนด API
• การนำเข้าข้อกำหนดของ OpenAPI (OpenAPI 2.0 หรือ 1.2)
• การสร้างทรัพยากรและวิธีการด้วยตนเอง

นอกจากนี้คุณยังนำเข้าไฟล์ JSON ของ SmartDocuments ลงในโมเดลได้ด้วย โดยปกติแล้วไฟล์นี้จะสร้างโดย ก่อนอื่นให้ส่งออกโมเดลที่มีอยู่ แก้ไขไฟล์ แล้วนำเข้าการอัปเดต สำหรับข้อมูลเพิ่มเติม ดู "การส่งออกและนำเข้าโมเดล" ที่ด้านล่าง

นำเข้า WADL

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

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน Drupal เมนูการดูแลระบบ
3. เลือกโมเดลที่ต้องการอัปเดต
4. เลือกนำเข้าในส่วนการดำเนินการ
5. เลือก WADL ในเมนูแบบเลื่อนลงเลือกรูปแบบบน หน้าการนำเข้าของ Smart Docs
6. เลือกไฟล์หรือ URL ในอัปโหลด เมนูแบบเลื่อนลงของประเภท
   1. หากเลือกไฟล์ ให้เรียกดูไฟล์ WADL
   2. หากคุณเลือก URL ให้ระบุ URL ของไฟล์ WADL
7. คลิกนำเข้าเพื่อนำเข้าไปยังโมเดล ตอนนี้คุณสามารถ แสดงผลโมเดล
8. ระบบจะเปลี่ยนเส้นทางคุณไปยังหน้าข้อมูลของโมเดล ซึ่งเป็นที่ที่คุณสามารถแสดงผล โมเดล

นำเข้า OpenAPI ข้อกำหนด

หลังจากสร้างโมเดลเรียบร้อยแล้ว คุณก็นำเข้า OpenAPI (เดิมคือ Swagger) ได้ ข้อมูลจำเพาะ Edge รองรับ OpenAPI เวอร์ชัน 1.2 และ 2.0

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

วิธีนำเข้าข้อกำหนดของ OpenAPI

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. เลือกโมเดลที่ต้องการอัปเดต
4. เลือกนำเข้าในส่วนการดำเนินการ
5. เลือก SSwagger JSON หรือ Swagger YAML ใน เมนูแบบเลื่อนลงเลือกรูปแบบในหน้าการนำเข้าของ SmartDocuments
6. เลือกไฟล์หรือ URL ใน เมนูแบบเลื่อนลงประเภทการอัปโหลด (คุณต้องเลือก URL สำหรับ OpenAPI 1.2)
   1. หากคุณเลือกไฟล์ ให้เรียกดู OpenAPI ข้อมูลจำเพาะ
   2. หากเลือก URL ให้ระบุ URL ของ OpenAPI ข้อมูลจำเพาะ
7. คลิกนำเข้าเพื่อนำเข้าไปยังโมเดล
8. ระบบจะเปลี่ยนเส้นทางคุณไปยังหน้าข้อมูลของโมเดล ซึ่งเป็นที่ที่คุณสามารถแสดงผล โมเดล

สร้างทรัพยากรด้วยตนเอง และวิธีการ

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

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

1. สร้างการแก้ไขใหม่ของโมเดล
   
   เมื่อสร้างการแก้ไข คุณจะระบุเส้นทางฐานเดียวของ API ทั้งหมดในโมเดล ซึ่งหมายความว่า API ทั้งหมดในโมเดลจะใช้เส้นทางฐานเดียวกัน เช่น ระบุเส้นทางฐาน เป็น:
   
   https://myCompany.com/v1
   
   เมื่อคุณเพิ่มทรัพยากรลงในโมเดล ทรัพยากรจะขยายเส้นทางฐาน
2. กำหนดทรัพยากรอย่างน้อย 1 รายการสำหรับโมเดล เส้นทางทรัพยากรรวมกับเส้นทางฐาน ของการแก้ไขโมเดลเพื่อระบุ URL แบบเต็มของทรัพยากร เช่น หากแหล่งข้อมูลของคุณ กำหนดเส้นทางของ "/login" โดย URL แบบเต็มของทรัพยากรคือ
   
   https://myCompany.com/v1/login
3. กำหนดเมธอดอย่างน้อย 1 รายการสำหรับทรัพยากรแต่ละรายการ เมธอดจะระบุคำกริยา HTTP ที่สามารถ ในทรัพยากร ตัวอย่างเช่น สำหรับ "/login" คุณสามารถสนับสนุน POST สำหรับการลงชื่อเข้าใช้และ DELETE เพื่อออกจากระบบ ทรัพยากรนี้ไม่สนับสนุนกริยา HTTP อื่นๆ เช่น PUT หรือ GET ดังนั้น ให้กำหนดวิธีการ 2 วิธีสำหรับทรัพยากร วิธีแรกสำหรับ POST และอีกวิธีสำหรับ DELETE
   
   เมธอดนี้ใช้ URL ทรัพยากรจากทรัพยากรระดับบนสุด ดังนั้น เมธอดทั้งหมดที่มี URL จะกำหนดไว้ภายใต้ทรัพยากรเดียวใน SmartDocuments

ตามกฎทั่วไป:

• สร้าง SmartDOC รูปแบบต่างๆ สำหรับเส้นทางฐานที่ไม่ซ้ำกันแต่ละเส้นทางใน API
• กำหนดทรัพยากร SmartDOC ต่างๆ สำหรับทรัพยากรที่ไม่ซ้ำกันแต่ละรายการใน API ของคุณ
• กำหนดเมธอด Smartdocs ที่แตกต่างกันสําหรับกริยา HTTP แต่ละคําที่ทรัพยากรรองรับ

การสร้างการแก้ไขใหม่ของโมเดล

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

วิธีสร้างการแก้ไขใหม่ของโมเดล

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการอัปเดต ให้เลือกเพิ่ม การแก้ไข ในส่วนการดำเนินการ
4. ในหน้าเพิ่มการแก้ไข API ให้ป้อนข้อมูลต่อไปนี้
   • ชื่อที่แสดง: ชื่อของการแก้ไขตามที่ปรากฏใน พอร์ทัล
   • รหัสเวอร์ชัน: ตัวระบุสั้นๆ สำหรับการแก้ไข
   • คําอธิบาย: คําอธิบายการแก้ไข
   • URL หลัก: URL พื้นฐานของ API ทั้งหมดในการแก้ไขโมเดล ต สามารถใช้ URL ฐานที่แตกต่างกันสำหรับการแก้ไขแต่ละครั้ง เช่น ระบุเวอร์ชัน ใน URL ฐาน สำหรับการแก้ไขโมเดลแรก URL ฐานคือ
     https://myCompany.com/v1
     สำหรับการแก้ไขครั้งต่อไป URL พื้นฐานอาจเป็น:
     https://myCompany.com/v2
5. เลือกเพิ่มการแก้ไข ระบบจะเปลี่ยนเส้นทางคุณไปยังหน้าการแก้ไขของโมเดล ตอนนี้คุณกำหนดทรัพยากรบนโมเดลได้แล้ว

การกำหนดทรัพยากร

ทรัพยากรจะระบุ URL แบบเต็มของ API เมื่อกำหนดทรัพยากร คุณต้องระบุ เส้นทางทรัพยากร ซึ่งจะรวมกับ URL ฐานในการแก้ไขโมเดลเพื่อสร้าง URL แบบเต็ม ของทรัพยากร

วิธีกำหนดทรัพยากร

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการอัปเดต ในส่วนการดำเนินการ ให้เลือก API การแก้ไข เพื่อดูการแก้ไขทั้งหมดของโมเดล
4. เลือกการแก้ไขที่จะแก้ไข
5. ในหน้าการแก้ไข ให้เลือกเพิ่มแหล่งข้อมูลจากเมนูแบบเลื่อนลง
6. ในหน้าเพิ่มแหล่งข้อมูล ให้ป้อนข้อมูลต่อไปนี้
   • ชื่อที่แสดง: ชื่อของทรัพยากร
   • เส้นทาง: เส้นทางทรัพยากรที่ขึ้นต้นด้วย "/" ค่าของ เส้นทางจะรวมเข้ากับ URL หลักของการแก้ไขโมเดล เพื่อสร้าง URL แบบเต็มของทรัพยากร
   • คำอธิบาย: คำอธิบายทรัพยากร
   • พารามิเตอร์: เลือกป้อนออบเจ็กต์ JSON ที่กําหนดพารามิเตอร์แต่ละรายการ ในแหล่งข้อมูล พารามิเตอร์เหล่านี้อธิบายไว้ด้านล่าง
7. เลือกเพิ่มทรัพยากร ระบบจะเปลี่ยนเส้นทางคุณไปยังหน้าโมเดล ตอนนี้คุณสามารถ กำหนดเมธอดในทรัพยากร

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

หรือคุณจะกําหนดพารามิเตอร์ในเมธอดก็ได้ เช่น เมธอด POST อาจรองรับ พารามิเตอร์การค้นหาที่เมธอด DELETE ไม่รองรับ ดังนั้น ให้เพิ่มพารามิเตอร์ เฉพาะเมธอดเมื่อคุณกำหนดเมธอด ดังที่อธิบายไว้ด้านล่าง

ภาพต่อไปนี้แสดงหน้า SmartDocuments ที่มีอยู่สำหรับ Apigee จะอนุมัติหรือเพิกถอน Developer App API ที่ไฮไลต์พารามิเตอร์แต่ละประเภทไว้ดังนี้

พารามิเตอร์แต่ละประเภทจะกำหนดโดยออบเจ็กต์ JSON ดังนี้

ประเภท	ออบเจ็กต์ JSON	หมายเหตุ
เทมเพลต	{ "dataType": "สตริง", "defaultValue": "", "description": "ชื่อองค์กร", "name": "org_name", "required": จริง, "type": "TEMPLATE" }	ต้องมีพารามิเตอร์เทมเพลตเสมอ ดังนั้นโปรดตั้งค่า required เป็น true และละเว้นค่าเป็น defaultValue ค่า description จะปรากฏขึ้นในป๊อปอัปเมื่อผู้ใช้วางเมาส์เหนือ URL ในหน้า SmartDocument
การค้นหา	{ "dataType": "สตริง", "defaultValue": "", "description": "สถานที่ตั้ง", "name": "w", "required": จริง, "type": "QUERY" }	พารามิเตอร์ข้อความค้นหาที่จำเป็นยังคงสามารถระบุ defaultValue ได้ แต่มักจะไม่ระบุ สำหรับพารามิเตอร์ข้อความค้นหาที่ไม่บังคับ ให้ตั้งค่า required เป็น false และระบุค่าเป็น defaultValue
ส่วนหัว	{ "dataType": "สตริง", "defaultValue": "application/json", "description": "ระบุเป็น <code>application/json</code>", "name": "ประเภทเนื้อหา", "required": จริง "type": "HEADER" }	สังเกตวิธีที่คุณสามารถใช้แท็ก HTML ในคำอธิบาย

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

[
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the organization name.",
  "name": "org_name",
  "required": true,
  "type": "TEMPLATE"
 },
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the user email.",
  "name": "developer_email",
  "required": true,
  "type": "TEMPLATE"
 }
]

จากนั้นคุณจะใช้พารามิเตอร์เทมเพลตในคำอธิบายเส้นทางทรัพยากร "{}" ได้ เช่น กำหนดเส้นทางไปยัง

/login/{org_name}/{developer_email}

ในหน้า SmartDOCS API ผู้ใช้ต้องแก้ไข URL เพื่อระบุส่วน org_name และ developer_email ของ URL ก่อน พวกเขาก็สามารถส่งคำขอได้

การกำหนดวิธีการ

กำหนดเมธอดอย่างน้อย 1 รายการสำหรับทรัพยากรแต่ละรายการ คำจำกัดความของเมธอดระบุคำกริยา HTTP ซึ่งสามารถเรียกใช้ในทรัพยากรได้ ทรัพยากรสามารถมีเมธอดเดียวกำหนดไว้ หรือ หลายวิธี

ในฐานะที่เป็นส่วนหนึ่งของการกำหนดเมธอด ให้ระบุพารามิเตอร์ที่ใช้เมธอดนั้น ซึ่งรวมถึงข้อความค้นหาและ พารามิเตอร์ส่วนหัว ดูแหล่งข้อมูลเกี่ยวกับการเพิ่มพารามิเตอร์จากคำอธิบายด้านบน ลงในเมธอด

รูปภาพต่อไปนี้แสดงหน้า SmartDocuments ที่มีอยู่สำหรับ Apigee Create Developer API ด้วย แต่ละพื้นที่ของหน้าที่ไฮไลต์ด้วยค่าที่เกี่ยวข้องซึ่งคุณได้กำหนดไว้เมื่อกำหนด วิธีการ:

ภาพถัดไปแสดงหน้าเดียวกัน แต่มีคำอธิบายของส่วนคำขอที่เลือก:

หากต้องการกำหนดเมธอด ให้ทำดังนี้

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการอัปเดต ในส่วนการดำเนินการ ให้เลือก API การแก้ไข เพื่อดูการแก้ไขทั้งหมดของโมเดล
4. เลือกการแก้ไขที่จะแก้ไข
5. ในหน้าการแก้ไข ให้เลือกเพิ่มเมธอดจากเมนูแบบเลื่อนลงสำหรับ แหล่งข้อมูล
6. ในหน้าแก้ไขวิธีการ ให้ป้อนข้อมูลต่อไปนี้
   • ชื่อที่แสดง: ชื่อของ API ซึ่งจะกลายเป็นชื่อของ API ด้วย หน้า Drupal สำหรับ API
   • คำอธิบาย: อธิบาย API
   • เมธอด Verb: ประเภทกริยา HTTP
   • แผนการรักษาความปลอดภัย: ระบุโหมดการตรวจสอบสิทธิ์ (หากมี) สำหรับ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการกำหนดค่าการตรวจสอบสิทธิ์ SmartDocuments type
   • ประเภทเนื้อหา: ประเภทเนื้อหาของคําขอและคําตอบ โปรดดู ด้านล่างเกี่ยวกับการกำหนดค่าวิธีการตรวจสอบสิทธิ์แบบต่างๆ
   • พารามิเตอร์: (ไม่บังคับ) พารามิเตอร์คำค้นหาหรือส่วนหัวสำหรับเมธอด หากต้องการข้อมูลเพิ่มเติม โปรดดูคำอธิบายด้านบนสำหรับการเพิ่มพารามิเตอร์ลงในแหล่งข้อมูล
   • เอกสารประกอบของคำขอ: (ไม่บังคับ) อธิบายเนื้อหาของคำขอ โพสต์ และวิธีการ PUT จะรับเนื้อหาคำขอ คุณสามารถใช้ส่วนนี้เพื่ออธิบายได้ หากคุณข้ามส่วนนี้ ระบบจะไม่ลิงก์ Description ใต้ Request Body จากหน้า Smartdocs ที่สร้างขึ้น
   • ตัวอย่างเนื้อความของคำขอ: (ไม่บังคับ) แสดงตัวอย่างเนื้อหาของคำขอ ซึ่งปกติจะเป็นออบเจ็กต์ JSON หรือ XML สำหรับคำกริยา POST และ PUT คอลัมน์ Request Body ตัวอย่างจะถูกส่งเป็นส่วนหนึ่งของคำขอแต่ละรายการ ผู้ใช้ของหน้า SmartDocuments สามารถแก้ไขเอกสารนี้ได้ ตัวอย่างก่อนส่งคำขอไปยัง API หากคุณไม่ระบุค่านี้ พารามิเตอร์ ลิงก์ ค่า ในส่วน เนื้อหาคำขอ จะไม่รวมอยู่ในฟิลด์ หน้า SmartDocuments ที่สร้าง
   • แท็ก: อาร์เรย์ของแท็กที่เชื่อมโยงกับ API SmartDocuments ใช้แท็กเพื่อ จัดกลุ่ม API ที่คล้ายกันไว้ด้วยกัน ตัวอย่างเช่น คุณอาจใช้แท็ก "สถิติ" ไปยัง API ทั้งหมด เกี่ยวกับสถิติ คุณจัดกลุ่ม API จากทรัพยากรที่แตกต่างกันได้โดยใช้แท็กเดียว หาก ทุกคนใช้แท็กเดียวกัน
7. เลือก Add Method ระบบจะเปลี่ยนเส้นทางคุณไปยังหน้าโมเดล ตอนนี้คุณสามารถ แสดงผลและเผยแพร่เมธอดของคุณ

การแสดงผลโมเดล

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

คุณสามารถเลือกแสดงผลโมเดลทั้งหมดพร้อมกัน หรือเลือก API ทีละรายการสำหรับ ในการแสดงภาพ

วิธีแสดงผลโมเดล

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการแสดงผล ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
4. เลือกการแก้ไขที่ต้องการแสดงผล คุณสามารถแสดงผลโหนดจากการแก้ไขเพียงครั้งเดียวของ โมเดล
5. เลือกวิธีแสดงผล
6. เลือกแสดงผลโหนดจากอัปเดต options แบบเลื่อนลง
7. คลิกอัปเดต
8. หน้าจอการโหลดจะปรากฏขึ้นเพื่อดูความคืบหน้าของโหนดที่กำลังแสดงผล
   หลังจากแสดงผลโหนดแล้ว รหัสของโหนด Drupal สำหรับ API แต่ละรายการจะปรากฏใต้คอลัมน์ คอลัมน์การเชื่อมโยงโหนดของโมเดล คลิกที่ลิงก์ใน โหนด การเชื่อมโยง เพื่อดูโหนดที่แสดงผล

แทนที่จะเลือกแสดงผลโหนด คุณสามารถเลือกแสดงผล และเผยแพร่โหนดเพื่อแสดงผลและเผยแพร่ API เป็นโหนด Drupal ทันที

โหนดการเผยแพร่

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

วิธีเผยแพร่โหนด

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการนำไปใช้จริง ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
4. เลือกการแก้ไขที่ต้องการเผยแพร่ คุณเผยแพร่โหนดได้จากการแก้ไขรายการเดียวเท่านั้น ของโมเดลดังกล่าว
5. เลือกวิธีที่จะเผยแพร่
6. เลือกโหนดในการแก้ไขที่จะเผยแพร่
7. เลือกเผยแพร่โหนดจากหน้าอัปเดต options แบบเลื่อนลง
8. คลิกอัปเดต
9. ไปที่โหนดโดยเลือกรหัสโหนดใต้การเชื่อมโยงโหนด

โดยค่าเริ่มต้น URL ของ Drupal ไปยังโหนด API ที่เผยแพร่จะอยู่ในรูปแบบ http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath> โปรดใช้ขั้นตอนต่อไปนี้เพื่อควบคุมรูปแบบของ URL

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือกการกำหนดค่า > การค้นหาและข้อมูลเมตา > ชื่อแทน URL > รูปแบบในเมนูการดูแลระบบของ Drupal
3. ในส่วน รูปแบบสำหรับเส้นทางเมธอด SmartDocuments ทั้งหมด ให้ระบุวิธีที่ต้องการ สร้างเส้นทาง
4. เลือกบันทึกการกำหนดค่า

เนื่องจากการแคชบนพอร์ทัล คุณอาจไม่เห็นหน้าโมเดลของคุณปรากฏขึ้นในทันที หลังจากเผยแพร่ หากจำเป็น คุณสามารถล้างแคช HTML ของ Smartdocs ได้ด้วยตนเองโดยใช้ ขั้นตอนต่อไปนี้

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือกการกำหนดค่า > SmartDocuments ในการดูแลระบบ Drupal เมนู
3. คลิกสร้างแคชของโมเดล Smartdocs ใหม่

การยกเลิกการเผยแพร่โหนด

คุณสามารถยกเลิกการเผยแพร่โหนดที่เผยแพร่แล้วได้ทุกเมื่อ การยกเลิกการเผยแพร่โหนดทำให้โหนดไม่แสดงต่อ ผู้ใช้พอร์ทัล

วิธียกเลิกการเผยแพร่โหนด

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการยกเลิกการเผยแพร่ ให้เลือกการแก้ไข API ใต้ การดำเนินการ
4. เลือกการแก้ไขโมเดลของโหนดที่ต้องการยกเลิกการเผยแพร่
5. เลือกโหนดในการแก้ไขเพื่อยกเลิกการเผยแพร่
6. เลือกโหนดยกเลิกการเผยแพร่จากอัปเดต options แบบเลื่อนลง
7. คลิกอัปเดต

การดูการแก้ไขของโมเดล

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

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

วิธีดูการแก้ไขโมเดล

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการอัปเดต ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
4. เลือกการแก้ไขโมเดลที่ต้องการดู
5. แสดงผลและเผยแพร่โหนดตามที่อธิบายไว้ข้างต้น

การแก้ไขโหนด

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

นอกจากนี้คุณยังแก้ไขไฟล์ WADL ต้นฉบับหรือข้อกำหนดของ OpenAPI ได้ด้วย เมื่อดำเนินการเสร็จแล้ว แก้ไข นำเข้าไฟล์ WADL หรือ OpenAPI Specification กลับไปยังโมเดลเป็นการแก้ไขใหม่ จากนั้นแสดงผลและเผยแพร่การเปลี่ยนแปลง ตามที่อธิบายไว้ข้างต้น

วิธีแก้ไขโหนดโดยใช้เครื่องมือแก้ไข Drupal

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เรียกดูโหนด Drupal ที่สอดคล้องกับเอกสารประกอบของ API ที่คุณต้องการ แก้ไข
3. เลือก Edit เพื่อใช้เครื่องมือแก้ไข Drupal
4. หลังจากแก้ไขเสร็จแล้ว ให้เลือก Update Method

หรือจะแก้ไขโหนดจากโมเดล SmartDocuments ก็ได้ โดยทำดังนี้

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการอัปเดต ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
4. เลือกการแก้ไขโมเดลที่ต้องการเผยแพร่
5. เลือกแก้ไขวิธีการในเมนูแบบเลื่อนลงการดำเนินการสำหรับ ที่คุณต้องการแก้ไข

วิธีลบโหนด

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการอัปเดต ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
4. เลือกการแก้ไขโมเดลที่ต้องการเผยแพร่
5. เลือกลบวิธีการใน เมนูแบบเลื่อนลงการดำเนินการของเมธอด
   ข้อควรระวัง: การลบโหนดจะเป็นการนำ API ออกจากโมเดลด้วย หากคุณเพียงแค่ ต้องการยกเลิกการเผยแพร่ API เพื่อซ่อนไม่ให้ผู้ใช้พอร์ทัลเห็น แต่ไม่ต้องการลบออก จากโมเดลนี้ คุณควรเลิกเผยแพร่โหนดตามที่อธิบายไว้ข้างต้น

พอร์ทัลมีรายงานในตัวซึ่งแสดงข้อมูลเกี่ยวกับโหนดที่จะแสดงผลโดย โมเดล SmartDocuments ซึ่งไม่ใช่วิธีการที่ถูกต้องของโมเดลอีกต่อไป เข้าถึงรายงานภายใน เลือกรายงานในเมนู Drupal แล้วเลือกรายงาน ชื่อว่าสถานะโหนด Smartdocs

การส่งออกและนำเข้าโมเดล

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

การนำเข้าโมเดลจะสร้างการแก้ไขใหม่ของโมเดล SmartDocuments จะพยายามจับคู่ข้อมูลที่มีอยู่ API ในโมเดลที่มี API ที่นำเข้า หาก SmartDocuments ตรวจพบการจับคู่ การนำเข้าจะอัปเดต Drupal โหนดที่สอดคล้องกับ API ที่มีอยู่ หาก SmartDocuments ตรวจไม่พบข้อมูลที่ตรงกัน ระบบจะนำเข้า สร้างโหนด Drupal ใหม่สำหรับ API

ตัวอย่างเช่น คุณมี POST API ที่สอดคล้องกับโหนด Drupal ที่มีรหัส 91 จากนั้น นำเข้าโมเดลและ SmartDocuments จะตรวจหาการจับคู่ของ POST API ในรูปแบบที่นำเข้ากับรายการที่มีอยู่ POST API การอัปเดต POST API จากนั้นอัปเดตโหนด Drupal 91 หาก SmartDocuments ตรวจไม่พบ ระบบจะสร้างโหนด Drupal ใหม่ที่มีรหัสใหม่

Drupal จะดำเนินการจับคู่โดยใช้ลักษณะเฉพาะต่อไปนี้ของ API

• internalName: ชื่อโมเดลภายใน
• httpMethod: เมธอด HTTP ของ API เช่น GET, PUT, POST หรือ ลบ
• resourcePath: เส้นทางทรัพยากร
• พารามิเตอร์การค้นหา: พารามิเตอร์การค้นหาใดๆ ที่ API ใช้

หากลักษณะทั้ง 4 ประการของ API ที่นำเข้าตรงกับ API ที่มีอยู่ในโมเดล SmartDocuments จะอัปเดตโหนด Drupal ที่มีอยู่

โมเดลที่ส่งออกจะแสดงเป็นออบเจ็กต์ JSON เดี่ยวพร้อมรายการสำหรับทรัพยากรและ ซึ่งหมายความว่าคุณสามารถแก้ไขโมเดลที่ส่งออกเพื่อแก้ไขทรัพยากรหรือเมธอด จากนั้น นำเข้าโมเดลอีกครั้ง หากคุณแก้ไขออบเจ็กต์ JSON อย่าแก้ไขช่องต่อไปนี้

• revisionNumber
• createdTime
• modifiedTime
• apiRevisionId
• resourceId

วิธีส่งออกโมเดล

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการส่งออก ให้เลือกส่งออกใต้ การดำเนินการ
4. เลือกประเภทไฟล์ส่งออกเป็น Smartdocs JSON
5. คลิกส่งออก
6. คุณจะได้รับข้อความแจ้งให้บันทึกไฟล์ลงในดิสก์หรือเปิดไฟล์ในตัวแก้ไข

วิธีนำเข้าโมเดล

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการนำเข้า ให้เลือกนำเข้าใต้ การดำเนินการ
4. เลือก Smartdocs JSON ในเมนูแบบเลื่อนลงเลือกรูปแบบ
5. เลือกไฟล์หรือ URL ใน ประเภทการอัปโหลด
   1. หากคุณเลือกไฟล์ ให้เรียกดูไฟล์ JSON
   2. หากคุณเลือก URL ให้ระบุ URL ของไฟล์ JSON ของ Smartdocs
6. คลิกนำเข้าเพื่อนำเข้าไปยังโมเดล
7. ระบบจะเปลี่ยนเส้นทางคุณไปยังหน้าข้อมูลของโมเดล ซึ่งเป็นที่ที่คุณสามารถแสดงผล โมเดล โปรดทราบว่าการนำเข้าจะสร้างการแก้ไขใหม่ของโมเดล
8. แสดงผลและเผยแพร่โหนด

การแก้ไขเทมเพลต Smartdocs

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

เทมเพลต SmartDocuments จะรวมไฟล์เทมเพลตที่มีโค้ดเป็นไฟล์ .hbr ของ Handlebar, ไฟล์ CSS และไฟล์ JavaScript ด้วยมือจับ เนื้อหาส่วนใหญ่จะขึ้นอยู่กับตัวแปรโดยใช้แบบฝัง นิพจน์ของแฮนเดิล เช่น &123;&123;body}} รายการที่มีอยู่ การแสดงออกของแถบควบคุมจะอยู่ในความคิดเห็นที่ด้านบนของไฟล์ สำหรับข้อมูลเกี่ยวกับ การใช้แถบควบคุมเพื่อปรับแต่งเทมเพลต โปรดดู http://handlebarsjs.com

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

การอัปโหลดที่กำหนดเอง ไฟล์เทมเพลต Smartdocs

คุณสามารถอัปโหลดไฟล์เทมเพลต Smartdocs ที่กำหนดเองเป็นไฟล์ .hbr ของแถบควบคุมสำหรับใช้เป็น เทมเพลตเริ่มต้นเมื่อสร้างโมเดลใหม่หรือนำเข้า API ใหม่ไปยังโมเดลที่มีอยู่

หากต้องการใช้ไฟล์เทมเพลต SmartDocuments เริ่มต้นเป็นจุดเริ่มต้นเมื่อสร้าง ไฟล์เทมเพลต SmartDocuments ที่กําหนดเอง คุณจะดาวน์โหลดสําเนาได้จากสิ่งต่อไปนี้ profiles/apigee/modules/custom/devconnect/smartdocs/templates/smartdocs.hbr

วิธีอัปโหลดไฟล์เทมเพลต Smartdocs ที่กำหนดเอง

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก การกำหนดค่า > SmartDocuments ใน Drupal เมนูการดูแลระบบ
3. ขยายพื้นที่การตั้งค่าขั้นสูงของหน้า
4. ในส่วน "อัปโหลดเทมเพลตวิธีการที่กำหนดเอง" ให้คลิกเลือกไฟล์ และ ไปที่ไฟล์ .hbr ของ Handlebar
5. คลิกอัปโหลด
6. คลิก Save Configuration

กำลังคืนค่า ไฟล์เทมเพลต Smartdocs เริ่มต้น

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

วิธีคืนค่าไฟล์เทมเพลต Smartdocs เริ่มต้น

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก การกำหนดค่า > SmartDocuments ใน Drupal เมนูการดูแลระบบ
3. ขยายพื้นที่การตั้งค่าขั้นสูงของหน้า
4. ในส่วน "อัปโหลดเทมเพลตวิธีที่กำหนดเอง" ให้คลิกนำออกที่อยู่ติดกับ ไฟล์เทมเพลต SmartDocuments ที่กำหนดเอง
5. คลิก Save Configuration

กำลังแก้ไข เทมเพลต SmartDOCUMENT ของโมเดลแต่ละรุ่น

คุณแก้ไขเทมเพลตที่ใช้สำหรับแต่ละโมเดลได้

วิธีแก้ไขเทมเพลตสำหรับโมเดลแต่ละรายการ

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่คุณต้องการแก้ไข ให้เลือกการตั้งค่าใต้ การดำเนินการ
4. ในพื้นที่ Method เทมเพลต ให้แก้ไขเทมเพลตตามที่จำเป็น
5. คลิกบันทึกเทมเพลต
6. เรียกดูโหนด Drupal คุณจะเห็นการเปลี่ยนแปลงเทมเพลตในหน้า

การกำหนดค่าพารามิเตอร์ ประเภทการตรวจสอบสิทธิ์ SmartDocuments

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

สำหรับ API ที่ปลอดภัย Smartdocs จะรองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

• การตรวจสอบสิทธิ์พื้นฐาน - ผ่านข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์พื้นฐานในฐานะ ชื่อผู้ใช้และรหัสผ่าน หากคุณไม่ระบุให้ใช้ OAuth เป็นประเภทข้อมูลเข้าสู่ระบบ API ตั้งค่าเริ่มต้นให้ใช้การตรวจสอบสิทธิ์พื้นฐาน
• OAuth 2.0 - ผู้ให้บริการบุคคลที่สามจะตรวจสอบสิทธิ์ของผู้ใช้ เข้าสู่ระบบ เพื่อให้แน่ใจว่าผู้ใช้มีสิทธิ์ในการเข้าถึง API จากนั้นจึงออกการเข้าถึง โทเค็น เมื่อคุณส่งคำขอ SmartDocument ไปยัง API ที่มีการป้องกัน SmartDocuments จะสร้างคำขอนั้นและ ส่งไปยังผู้ให้บริการ จากนั้นผู้ให้บริการจะตรวจสอบโทเค็นและตรวจสอบว่า ว่ายังไม่หมดอายุ
• โทเค็นที่กำหนดเอง - ส่งค่าโทเค็นเป็นส่วนหัวหรือพารามิเตอร์การค้นหาให้แต่ละรายการ อีกครั้ง

สำหรับการตรวจสอบสิทธิ์แต่ละประเภท คุณจะสร้างรูปแบบการรักษาความปลอดภัยที่กำหนด ลักษณะเฉพาะของการตรวจสอบสิทธิ์ ตัวอย่างเช่น สำหรับการตรวจสอบสิทธิ์โทเค็นที่กำหนดเอง รูปแบบการรักษาความปลอดภัยจะกำหนดวิธีส่งโทเค็น (ส่วนหัว พารามิเตอร์การค้นหา พารามิเตอร์เนื้อหา) และชื่อของ โทเค็น

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

ในไฟล์ WADL คุณจะระบุว่า API ต้องมีการตรวจสอบสิทธิ์หรือไม่ โดยใช้แท็ก Apigee &lt;apigee:authentication&gt; แบบ แสดงอยู่ด้านล่าง

<method id="statusespublic_timeline" name="GET" apigee:displayName="PublicTimeline">
    ...
    <apigee:authentication required="true"/>
</method> 

หาก API เปิดอยู่ ให้ตั้งค่าแอตทริบิวต์ required เป็น false

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

ในหน้า API ของ Drupal SmartDocuments จะเพิ่มปุ่มต่อไปนี้เพื่อให้ผู้ใช้สามารถระบุ ข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์พื้นฐาน:

หากคุณแก้ไขโหนดเพื่อตั้งค่าประเภทการตรวจสอบสิทธิ์เป็น OAuth จากนั้น SmartDocuments จะเพิ่มฟิลด์ ปุ่มต่อไปนี้ในหน้าเว็บ:

สำหรับโทเค็นที่กำหนดเอง Smartdocs จะเพิ่มข้อมูลต่อไปนี้

กำลังกำหนดค่า การตรวจสอบสิทธิ์พื้นฐาน

หากใช้การตรวจสอบสิทธิ์พื้นฐานกับ API คุณต้องระบุแท็ก &lt;apigee:authentication&gt; ใน WADL เท่านั้น ไฟล์ที่คุณใช้สร้างโมเดล

หากต้องการใช้การตรวจสอบสิทธิ์พื้นฐานกับเมธอดที่สร้างจากต้นทางอื่นที่ไม่ใช่ไฟล์ WADL ให้ทำดังนี้

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่ต้องการ ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
4. สำหรับการแก้ไขโมเดลที่คุณต้องการแก้ไข ให้เลือก ความปลอดภัย การตั้งค่าในส่วนการดำเนินการ
5. เลือกเพิ่มรูปแบบการรักษาความปลอดภัย
6. ระบุชื่อของรูปแบบการรักษาความปลอดภัย
7. เลือกประเภทเป็นพื้นฐาน
8. เลือกส่ง
9. สำหรับแต่ละเมธอดในโมเดล ให้แก้ไขเมธอดเพื่อตั้งค่าแผนการรักษาความปลอดภัย สคีมพื้นฐาน
   1. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
   2. สำหรับโมเดลที่ต้องการ ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
   3. สำหรับการแก้ไขโมเดลที่คุณต้องการแก้ไข ให้เลือก การแก้ไข รายละเอียดภายใต้การดำเนินงาน
   4. เลือกแก้ไขวิธีการสำหรับ API ที่ต้องการแก้ไข
   5. เลือกรูปแบบการรักษาความปลอดภัยสำหรับ API
   6. บันทึก API

กำลังกำหนดค่า การตรวจสอบสิทธิ์ OAuth 2.0

คุณสามารถกำหนดค่าโมเดลให้ใช้ OAuth 2.0 ใน Smartdocs แทนค่าเริ่มต้นขั้นพื้นฐานได้ การตรวจสอบสิทธิ์ คุณกำหนดค่า OAuth ใน 2 ตำแหน่งดังนี้

1. สร้างรูปแบบการรักษาความปลอดภัยสำหรับการแก้ไขแต่ละครั้งของโมเดลในส่วน ความปลอดภัย การตั้งค่าสำหรับการแก้ไข
2. ระบุรหัสไคลเอ็นต์และรหัสลับไคลเอ็นต์สำหรับการแก้ไขทั้งหมดของโมเดลภายใต้ การตั้งค่าสำหรับโมเดล

วิธีเปิดใช้ OAuth

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่ต้องการ ให้เลือกการแก้ไข API ในส่วนการดำเนินการ
4. สำหรับการแก้ไขโมเดลที่คุณต้องการแก้ไข ให้เลือกการตั้งค่าความปลอดภัยใต้ การดำเนินการ
5. เลือกเพิ่มรูปแบบการรักษาความปลอดภัย
6. ระบุชื่อของรูปแบบการรักษาความปลอดภัย
7. เลือก OAuth 2.0 เป็น Type
8. ตั้งค่าประเภทการให้สิทธิ์
9. ป้อนค่าในช่อง URL การให้สิทธิ์ การให้สิทธิ์ URL ใช้เพื่อรับโทเค็นเพื่อการเข้าถึง
10. ตั้งค่าคำกริยาการให้สิทธิ์เป็น GET หรือ POST
11. ป้อน URL ของโทเค็นเพื่อการเข้าถึง URL โทเค็นเพื่อการเข้าถึงคือ URL ที่ใช้เพื่อ แลกเปลี่ยนโทเค็นคำขอเป็นโทเค็นเพื่อการเข้าถึง
12. ป้อนชื่อพารามิเตอร์โทเค็นเพื่อการเข้าถึง
13. ใช้ In เพื่อระบุวิธีส่งโทเค็น ดังนี้ Header, Query หรือ Body
14. ตั้งค่าขอบเขต OAuth
15. เลือกส่ง
16. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
17. สำหรับโมเดล ให้เลือกการตั้งค่าในการดำเนินการ แบบเลื่อนลง
18. ป้อนค่าในรหัสลูกค้าและลูกค้า Secret
19. เลือกบันทึกการตั้งค่าการตรวจสอบสิทธิ์ของเทมเพลต
20. สำหรับแต่ละเมธอดในโมเดล ให้แก้ไขเมธอดเพื่อตั้งค่าแผนการรักษาความปลอดภัย รูปแบบความปลอดภัย OAuth
    1. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
    2. สำหรับโมเดลที่ต้องการ ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
    3. สำหรับการแก้ไขโมเดลที่คุณต้องการแก้ไข ให้เลือก การแก้ไข รายละเอียดภายใต้การดำเนินงาน
    4. เลือกแก้ไขวิธีการสำหรับ API ที่ต้องการแก้ไข
    5. เลือกรูปแบบการรักษาความปลอดภัยสำหรับ API
    6. บันทึก API

การกำหนดค่าการตรวจสอบสิทธิ์โทเค็นที่กำหนดเอง

คุณสามารถกำหนดค่าโมเดลเพื่อใช้การตรวจสอบสิทธิ์โทเค็นที่กำหนดเองได้

วิธีเปิดใช้โทเค็นที่กำหนดเอง

1. ลงชื่อเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ระดับผู้ดูแลระบบหรือการสร้างเนื้อหา
2. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
3. สำหรับโมเดลที่ต้องการ ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
4. สำหรับการแก้ไขโมเดลที่คุณต้องการแก้ไข ให้เลือก ความปลอดภัย การตั้งค่าในส่วนการดำเนินการ
5. เลือกเพิ่มรูปแบบการรักษาความปลอดภัย
6. ระบุชื่อของรูปแบบการรักษาความปลอดภัย
7. เลือก Apikey เป็น Type
8. กำหนดชื่อ พารัมที่มีโทเค็น
9. ใช้ In เพื่อระบุวิธีการส่งผ่าน โทเค็น: ส่วนหัว คำค้นหา หรือเนื้อความ
10. เลือกส่ง
11. สำหรับแต่ละเมธอดในโมเดล ให้แก้ไขเมธอดเพื่อตั้งค่าแผนการรักษาความปลอดภัย กับสคีมโทเค็นของคุณ
    1. เลือก เนื้อหา > SmartDocuments ใน เมนูการดูแลระบบของ Drupal
    2. สำหรับโมเดลที่ต้องการ ให้เลือกการแก้ไข API ในส่วน การดำเนินการ
    3. สำหรับการแก้ไขโมเดลที่คุณต้องการแก้ไข ให้เลือก การแก้ไข รายละเอียดภายใต้การดำเนินงาน
    4. เลือกแก้ไขวิธีการสำหรับ API ที่ต้องการแก้ไข
    5. เลือกรูปแบบการรักษาความปลอดภัยสำหรับ API
    6. บันทึก API

การลบโมเดล

เมื่อลบโมเดล (เนื้อหา > SmartDocuments ให้ลบใน ฟิลด์การดำเนินการใน Drupal) ระบบจะลบโมเดลออกจากองค์กร Edge ซึ่งหมายความว่าหาก พอร์ทัลอื่นๆ กำลังอ้างอิงโมเดลอยู่ โมเดลจะใช้งานไม่ได้อีกต่อไป สำหรับข้อมูลเพิ่มเติม ดูเกี่ยวกับรูปแบบและเทมเพลต SmartDoc