การเรียกเครื่องมือ

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

ประเด็นสำคัญ

• ตรวจสอบความถูกต้องของอำนาจและรูปร่างของอาร์กิวเมนต์
• ออกแบบการลองใหม่อย่างปลอดภัยสำหรับผลข้างเคียง
• ตรวจสอบสถานะผลลัพธ์

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

1. ลองนึกภาพเครื่องมือสร้างงานยอมรับตัวระบุคำขอ demo-17 การตอบสนองหมดเวลาหลังจากสร้างงานแล้ว
2. ค้นหา demo-17 ก่อนที่จะสร้างงานอื่น หากบริการรองรับ idempotency ให้ใช้ตัวระบุเดียวกันซ้ำสำหรับการลองอีกครั้ง
3. รายงานความสมบูรณ์หลังจากยืนยันงานผลลัพธ์และเนื้อหาแล้วเท่านั้น

ตัวอย่างที่สร้างขึ้นนี้แยกการขนส่งที่ไม่แน่นอนออกจากผลลัพธ์ที่แท้จริงของการกระทำภายนอก