একটি ওয়েব এপিআই অবচয়: সেরা অভ্যাসগুলি?


18

শেষ পর্যন্ত আপনাকে আপনার সর্বজনীন ওয়েব এপিআইয়ের কিছু অংশ অবমূল্যায়ন করতে হবে। তবে এটি করার সর্বোত্তম উপায়টি কী তা নিয়ে আমি বিভ্রান্ত। আপনার কাছে যদি একটি বৃহত তৃতীয় পক্ষের অ্যাপ বেস রয়েছে কেবলমাত্র এপিআই-র পুরানো সংস্করণগুলি ইয়াঙ্কিং করা এটির মতো ভুল উপায় বলে মনে হচ্ছে কারণ প্রায় সমস্ত অ্যাপ্লিকেশন রাতারাতি ব্যর্থ হয়ে যায়। তবে আপনি প্রাচীন ওয়েব এপিআইকে চিরকালের জন্য উপলব্ধ রাখতে পারবেন না কারণ এটি পুরানো হতে পারে বা উল্লেখযোগ্য পরিবর্তন রয়েছে যা এর সাথে কাজ করা অসম্ভব করে তোলে।

পুরানো ওয়েব এপিআই-কে অবমূল্যায়নের জন্য কয়েকটি সেরা অভ্যাসগুলি কী কী?

উত্তর:


17

মনে হচ্ছে আসল পোস্টার ইতিমধ্যে কার্যকরভাবে কার্যকর হয়েছে, তবে অনানুষ্ঠানিকভাবে তাদের এপিআই-কে ('পুরানো এপিআই' হিসাবে উল্লেখ করা এমন কিছু) অবমূল্যায়ন করেছে। যাইহোক, এটি ঘোষণা না হওয়া এবং ব্যবহারকারীদের এপিআই অবমাননিত হওয়ার বিষয়টি অবহিত না করা পর্যন্ত এটি আনুষ্ঠানিকভাবে হ্রাস করা হয় না।

অবহেলিত এপিআই হ'ল কোডের একটি অন্তর্বর্তী, নিষ্ক্রিয় পর্যায়। এটি শেষ আচার। এটি সেই সময়কাল যা গ্রহণকারীরা / গ্রাহকরা তাদের অ্যাপ্লিকেশনগুলিকে নতুন API এর জন্য পুনরায় কনফিগার করতে এবং এপিআইয়ের সাথে শান্তি স্থাপনের মাধ্যমে একটি স্নেহ বিদায় জানান b কিছু এপিআই অন্যের চেয়ে দীর্ঘায়িত হতে পারে তবে এই মুহুর্তে আমরা জানি তাদের সময় দীর্ঘ নয়।

মোছা এপিআই হ'ল একটি কোড জানাজা। এটি করতে পারে এমন আরও কিছু নেই তবে সঠিকভাবে নিষ্পত্তি হয় এবং যথাযথভাবে স্মৃতিস্তম্ভ হয়।

অনেক এপিআই এবং পরিষেবা বিকাশকারীরা শেষ রীতিনীতি সম্পাদন করার চেয়ে কোডের শেষকৃত্যের বিকল্প বেছে নেয়; তবে আমি মনে করি এটি কিছুটা ঝুঁকিপূর্ণ। যদি এপিআই / পরিষেবাটি প্রাথমিকভাবে গৃহীত হয় বা পুনর্নবীকরণের মাধ্যমে গৃহীত হয় তখন কোনও ধরণের পরিষেবা বা সমর্থন প্রতিশ্রুতি দেওয়া হয়েছিল, আপনি অন্ত্যেষ্টিক্রিয়া অনুষ্ঠানের আগে যুক্তিসঙ্গত সময়ের জন্য সেই প্রতিশ্রুতিটিকে সম্মান করতে চাইতে পারেন।

পরিষেবাবিহীন গ্রন্থাগারগুলির জন্য, আমি মনে করি একটি বড় রিলিজ সংস্করণ, সময়কাল নির্বিশেষে সম্ভবত গ্যারান্টিযুক্ত পিছনের সামঞ্জস্যতার গ্রহণযোগ্য এবং ন্যায্য সময়কালের চেয়ে বেশি। এর বাইরেও এটি সেই সময়ের বাইরেও তার জীবন বাড়ানোর জন্য ব্যবহারকারীদের প্রভাব এবং তদবিরের উপর নির্ভর করে। এবং অবাক না হয়ে 3 য় পক্ষের নির্ভরশীলতাগুলি লম্বা হয়ে আটকে থাকার কারণে এবং নির্দিষ্ট প্ল্যাটফর্মের কয়েকটি সংস্করণে আবদ্ধ থাকার কারণে যদি সময়ে সময়ে আপত্তি হয় তবে অবাক হবেন না।

পরিষেবাগুলির জন্য, আমি সন্দেহ করি যে আপনি কোনও ছয় মাস বা বছরের সময়কালের দিকে নজর দিতে চাইতে পারেন, কেবলমাত্র কোনও পরিষেবা কীভাবে ব্যয় করতে পারে তার বৈকল্পিকতার কারণে এবং গ্রাহক প্রকল্প থেকে গ্রাহক প্রকল্পের সাথে সম্পর্কিত উন্নয়ন চক্রের তারতম্য - আপনার পরিষেবা গ্রাস করতে পারে এমন অনেকগুলি প্রকল্প এখনও বড় আপ-ফ্রন্ট ডিজাইন করতে পারে এবং এক বছরেরও বেশি সময়ের জন্য একটি মুক্তির চক্র নির্ধারণ করতে পারে। বাইরে থেকে বেশিরভাগ বিকাশকারীদের মতামতটি পরামর্শ দেয় যে দীর্ঘ সময়সূচী থাকা ব্যক্তিরা আপনার চক্রের সময়গুলি পূরণের জন্য দায়বদ্ধ এবং সেই দীর্ঘ চক্র গ্রহীতা প্রকল্পগুলি দ্রুত রিলিজ চক্র গ্রহণ করবে এবং এটি সত্য হতে পারে। তবে শেষ পর্যন্ত মুছে ফেলার তারিখ এমন একটি বিষয় যা আপনাকে ব্যবহারকারীদের সাথে আলোচনার জন্য করতে হয়।

হ্রাসের ঘোষণা দেওয়ার সময় অবচয়ের জন্য একটি ভাল তবে বুলেটপ্রুফ কৌশল নাও হতে পারে, প্রশ্নে থাকা এপিআই বিভাগগুলির জরিপ বিন্যাসে মন্তব্য বা আপত্তির অনুরোধের সাথে মুছে ফেলার অভিপ্রায়টির সময়সীমাটি হাইলাইট করুন। যদি আপনার ব্যবহারকারীর যোগাযোগের তালিকা না থাকে কারণ আপনার পরিষেবাটি [অর্ধ] বেনামে অ্যাক্সেস নিয়ে কাজ করে, আপনি ঘন ঘন এবং সক্রিয় ব্যবহারকারীদের লগগুলি সন্ধান করতে পারেন এবং হোস্ট বা ডোমেন প্রশাসকের কাছে ঠিক দেখতে দেখতে বিজ্ঞপ্তিটি প্রেরণ করতে পারেন।


বাহ, খুব তথ্যপূর্ণ উত্তর
TheLQ

7

আমি ব্যবহার করি এমন ওয়েব এপিআইয়ের বেশিরভাগেরই (গুগল, ইয়াহু এবং মাইক্রোসফ্টের মতো সংস্থাগুলি থেকে) একটি "সূর্যাস্ত" সময়কাল থাকে। বিকাশকারীদের আগে থেকেই আপগ্রেড করার জন্য প্রচুর সময় দেওয়ার জন্য অবজ্ঞাত হতে যাওয়া বৈশিষ্ট্যগুলির একটি যুক্তিসঙ্গত সময়ের মধ্যে (3-6 মাস বলুন) অবহিত করা হয়।

আপনি আপনার পরিষেবার শর্তাদিতে বা অন্যান্য ডকুমেন্টেশনে সূর্যাস্তের সময়ের বিবরণ যুক্ত করতে পারেন যাতে লোকেরা কীভাবে এটি কাজ করে সে সম্পর্কে সচেতন। এর অর্থ হ'ল যখন কেউ আপনার এপিআই ব্যবহার করার সিদ্ধান্ত নেবেন তখন তারা জানতে পারবেন তাদের কোন শিডিউল নিয়ে কাজ করা উচিত। উদাহরণস্বরূপ, আপনি লোকদের জানাতে পারেন যে তাদের বছরে একবার তাদের সিস্টেম আপগ্রেড করতে হবে এবং এটি করার জন্য 4 মাসের নোটিশ পাবেন।

সংস্করণ নম্বর ব্যবহার করাও এটি একটি ভাল ধারণা যাতে আপনি বলতে পারেন যে, উদাহরণস্বরূপ, "সংস্করণ 3 শীঘ্রই হ্রাস পাচ্ছে তাই আপনার কোডটি সংস্করণ 4" এর সাথে কাজ করে তা নিশ্চিত করুন etc. ইত্যাদি লোকেরা জানেন যে যদি তাদের অ্যাপ্লিকেশনটি সংস্করণটির সাথে কাজ করে তবে 4 তারপরে তারা সূর্যাস্তের জন্য প্রস্তুত।


1

প্রক্রিয়া কোণ থেকে অতিরিক্ত তথ্য:

  • সমস্ত স্টেকহোল্ডারদের সাথে যোগাযোগ করুন : অন্যান্য দল এবং এপিআই গ্রাহকদের এপিআই, কৌশল, পরিকল্পনা এবং তফসিলের বিবরণ, সংস্করণ অর্থ এবং বিকল্পগুলির মূল্য নির্ধারণের কারণ সম্পর্কে একটি স্পষ্ট এবং সংক্ষিপ্ত যোগাযোগ সরবরাহ করুন, সেই অনুযায়ী HTTP সেট করুন।

  • পরিকল্পনা এবং সময়সূচি : পরিকল্পনায় আপনার অবমূল্যায়নের শেষের জন্য মূল মাইলফলক এবং লক্ষ্য তারিখ থাকা উচিত have আপনার ভোক্তাদের একই অনুরোধ করা উচিত এবং তারিখগুলি সরবরাহ করা উচিত যখন তারা কলটি অবমূল্যায়ন করবে। প্রক্রিয়াটি পর্যবেক্ষণ করতে এবং ভোক্তাদের সমর্থন করার জন্য একটি নিয়মিত সভা হোস্ট করুন।

  • সংস্করণকরণ এবং বিকল্প সরবরাহ : সংস্করণটি বড় রিলিজগুলিতে বিরতি পরিবর্তনগুলি দেখাতে, এবং API হ্রাসের কৌশল তৈরি করতে সহায়তা করতে পারে।

  • সানসেট এইচটিটিপি রেসপন্স শিরোনাম সেট করুন : এইচটিটিপি শিরোনামগুলি সতর্কতার প্রযুক্তিগত অংশটি খেলবে, এপিআই গ্রাহকদের এই ধরণের কোডটি যখন কোনও এপিআই হ্রাস করা হয় তখন তা বোঝার জন্য নজরদারি করা উচিত।

  • এর আগে ও পরে নিরীক্ষণ করুন: আপনার গ্রাহকদের নিরীক্ষণ করুন এবং নির্দিষ্ট সময়কালের পরেও এপিআই ব্যবহার করা এমন কোনও ভোক্তাকে সতর্ক করুন যাতে আপনি কোনও বিসর্জন বোধ করবেন না তা নিশ্চিত করতে দরকারী তথ্য information


0

বিদ্যমান উত্তরের পাশাপাশি, কিছু অপসারণ করার সময় আপনার একটি ড্রপ-ইন প্রতিস্থাপন বা মাইগ্রেশন পরিকল্পনা সরবরাহ করা উচিত, যাতে আপনার ব্যবহারকারীরা তাদের কোড আপডেট করতে পারেন।

বিকল্প সরবরাহ না করে কার্যকারিতা অপসারণ এড়াতে চেষ্টা করুন - এটি আপনার কিছু ব্যবহারকারীকে অসন্তুষ্ট করবে।


যদি এটি আপনার ওয়েব এপিআইতে সম্ভব হয়, অবহিত ফাংশনগুলিকে সক্রিয় রাখুন তবে তাদের কেবল ব্রেকিংয়ের পরিবর্তে একটি তথ্যমূলক ত্রুটি ফিরিয়ে দিন।
মনিকা
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.