এটার মত:
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"
আমি রেফারেন্স আইডি সম্পর্কে উদ্বিগ্ন ।
সিস্টেম ডোমেন এমন একটি প্ল্যাটফর্ম যা ডেটা রফতানি এবং বিভিন্ন ফর্ম্যাটের আমদানির মাধ্যমে (এক্সএমএল, এক্সেল) বিভিন্নভাবে তৃতীয় পক্ষের সাথে একীভূত হয়। এটি এপিআইয়ের মাধ্যমে তৃতীয় পক্ষগুলিকে আমাদের সিস্টেমের সাথে সংহত করার অনুমতি দেওয়ার পক্ষে যথেষ্ট পরিপক্ক এবং এই এপিআইয়ের নকশা যা এই প্রশ্নটি উত্সাহ দেয়।
আমাদের একটি অবজেক্ট, একটি প্রচারাভিযান রয়েছে, যার একটি আইডি রয়েছে যা সংস্থানটি সনাক্ত করতে এবং পুনরুদ্ধারে ব্যবহার করা যেতে পারে। আমাদের এপিআই এর গ্রাহকরা তাদের ডোমেনের মধ্যে একটি প্রচারণা হিসাবে বিবেচনা করে তার নিজস্ব রেফারেন্স কোড থাকতে পারে।
আমাদের সিস্টেমে এর মতো তৃতীয় পক্ষের রেফারেন্স ক্ষেত্র সহ অন্যান্য অবজেক্ট রয়েছে এবং এটি আমাদের বিদ্যমান গ্রাহকদের কাছ থেকে প্রত্যাশিত। তবে আমি উদ্বেগ করছি যে এটি আমাদের উপর ম্যাপিংয়ের বোঝা চাপিয়ে দেয় এবং আমরা জানি না যে এই রেফারেন্সটি কী (সংখ্যা, পাঠ্য, জসন?) কী এবং এটি নতুন গ্রাহকদের জন্য এপিআইতে আরও বিভ্রান্তিকর সম্পত্তি যুক্ত করে।
কোনও এপিআই-এর জন্য সর্বজনীন অবজেক্ট সংজ্ঞাগুলিতে তৃতীয় পক্ষের রেফারেন্স আইডি ক্ষেত্রগুলিকে মঞ্জুরি দেওয়ার জন্য খারাপ অনুশীলন বা খারাপ ডিজাইন হিসাবে বিবেচিত হয়?