แบบนี้:
Campaign:
type: object
properties:
id:
type: string
description: "A GUID identifier"
referenceId:
type: string
description: "A consumers identifier they have used to map their own systems logic to this object."
name:
type: string
description: "'Great Campaign 2017' as an example"
ผมกังวลเกี่ยวกับreferenceid
โดเมนระบบเป็นแพลตฟอร์มที่รวมเข้ากับบุคคลที่สามได้หลายวิธีผ่านการส่งออกข้อมูลและการนำเข้ารูปแบบต่างๆ (xml, excel) เป็นผู้ใหญ่พอที่จะอนุญาตให้บุคคลที่ 3 รวมกับระบบของเราผ่าน API และการออกแบบของ API นี้เป็นสิ่งที่แจ้งคำถามนี้
เรามีวัตถุเป็นแคมเปญซึ่งมีรหัสที่สามารถใช้ในการระบุและดึงทรัพยากร ผู้บริโภคของ API ของเราอาจมีรหัสอ้างอิงของตนเองกับสิ่งที่พวกเขาพิจารณาว่าเป็นแคมเปญภายในโดเมนของตน
มีวัตถุอื่น ๆ ในระบบของเราที่มีเขตข้อมูลอ้างอิงบุคคลที่สามเช่นนี้และเป็นที่คาดหวังจากผู้บริโภคที่มีอยู่ของเรา อย่างไรก็ตามฉันกังวลว่ามันเป็นภาระของการทำแผนที่กับเราและเราไม่ทราบว่าสิ่งที่อ้างอิงนี้คืออะไร (หมายเลข, ข้อความ, json?) และมันเพิ่มคุณสมบัติที่สับสนอีกอย่างสำหรับ API สำหรับผู้บริโภคใหม่
ถือว่าเป็นการปฏิบัติที่ไม่ดีหรือการออกแบบที่ไม่ดีเพื่ออนุญาตให้มีเขตข้อมูลรหัสอ้างอิงบุคคลที่สามในคำจำกัดความของวัตถุสาธารณะสำหรับ API หรือไม่