การเขียนโค้ด Intermediate XML Structured

นักวิเคราะห์ตรวจสอบสัญญา API

สำหรับวิศวกรที่ตรวจสอบการเปลี่ยนแปลง API ซึ่งอาจทำให้ลูกค้า สัญญา หรือการรับประกันความเข้ากันได้ย้อนกลับล้มเหลว

💻

Rating

4.7

Difficulty

Intermediate

Format

XML Structured

Variables

ดาวน์โหลด Prompt FREE

Best for these models

● Gemini 3.1 Pro ● Claude Sonnet 4.6 ● ChatGPT (GPT-5.4)

📋 The Prompt

XML Structured .txt

🔒 Prompt อยู่ในไฟล์ดาวน์โหลด

รับข้อความ prompt ฉบับเต็มในไฟล์ .txt ที่สามารถดาวน์โหลดได้ ฟรี ไม่ต้องสมัครสมาชิก

ดาวน์โหลด Prompt

Variables to fill in

{{CODE_DIFF}} — Replace with your input

{{API_STYLE}} — Replace with your input

{{COMPATIBILITY_RULES}} — Replace with your input

{{DOWNSTREAM_CLIENTS}} — Replace with your input

About this prompt

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

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

ปรับแต่งด้วย {{CODE_DIFF}} ประเภท API ใน {{API_STYLE}} และกฎความเข้ากันได้ใน {{COMPATIBILITY_RULES}} หากจุดเชื่อมต่อมีผู้บริโภคที่รู้จัก ให้เพิ่มใน {{DOWNSTREAM_CLIENTS}} เพื่อให้โมเดลสามารถประเมินขอบเขตความเสียหาย ผลลัพธ์รวมถึงความเสี่ยงด้านความเข้ากันได้ ตัวอย่างคำตอบที่แนะนำ และคำแนะนำสำหรับการปล่อยใช้งาน ใช้ควบคู่กับการวิเคราะห์ครอบคลุมการทดสอบเพื่อให้แน่ใจว่าทั้งการดำเนินการและพฤติกรรมสัญญานั้นได้รับการปกป้อง

Key features

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

Best for

→ เจ้าของ API ที่จัดการการเชื่อมต่อภายนอก
→ วิศวกร backend ที่ปล่อยการเปลี่ยนแปลง schema
→ ทีมแพลตฟอร์มที่ปกป้องสัญญาบริการ

Tips

💡 ระบุ downstream consumers ใน {{DOWNSTREAM_CLIENTS}} เพื่อวิเคราะห์ขอบเขตความเสียหายให้ดีขึ้น
💡 เพิ่มนโยบายเวอร์ชันของคุณใน {{COMPATIBILITY_RULES}} เพื่อการตัดสินใจที่เข้มงวดยิ่งขึ้น
💡 ใช้ร่วมกับการทดสอบ schema เมื่อจุดเชื่อมต่อถูกแชร์ข้ามทีม

What you'll get

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

Preparing your download...

ดาวน์โหลด Prompt