เลิกใช้ API ของเว็บ: แนวทางปฏิบัติที่ดีที่สุดหรือไม่

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

แนวทางปฏิบัติที่ดีที่สุดสำหรับการคัดค้าน API ของเว็บเก่าคืออะไร

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

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

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

API และนักพัฒนาบริการจำนวนมากเลือกใช้งานศพรหัสแทนที่จะทำพิธีกรรมครั้งสุดท้าย อย่างไรก็ตามฉันคิดว่าค่อนข้างมีความเสี่ยง หากมีการให้บริการหรือสัญญาสนับสนุนใด ๆ ที่เกิดขึ้นเมื่อมีการใช้ API / บริการในขั้นต้นหรือผ่านการต่ออายุคุณอาจต้องการที่จะให้เกียรติในข้อตกลงนั้นในช่วงระยะเวลาที่เหมาะสมก่อนดำเนินการงานศพ

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

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

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

เว็บ API ส่วนใหญ่ที่ฉันใช้ (จาก บริษัท เช่น Google, Yahoo! และ Microsoft) มีช่วงเวลา "พระอาทิตย์ตก" นักพัฒนาซอฟต์แวร์จะได้รับแจ้งภายในระยะเวลาที่เหมาะสม (ประมาณ 3-6 เดือน) ของคุณสมบัติที่จะถูกคิดค่าเสื่อมราคาเพื่อให้พวกเขามีเวลามากมายในการอัปเกรดล่วงหน้า

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

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

ข้อมูลเพิ่มเติมจากมุมกระบวนการ:

• สื่อสารกับผู้มีส่วนได้ส่วนเสียทั้งหมด : มอบการสื่อสารที่ชัดเจนและรัดกุมเกี่ยวกับเหตุผลในการเลิกใช้ API กลยุทธ์การวางแผนและรายละเอียดกำหนดการความหมายของการกำหนดรุ่นและทางเลือกต่างๆ

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

• การกำหนดเวอร์ชันและการจัดหาทางเลือก : การกำหนดเวอร์ชันอาจช่วยแสดงการเปลี่ยนแปลงการหยุดพักในการเผยแพร่ครั้งใหญ่และทำให้กลยุทธ์ของการเลิกใช้ API

• ตั้งค่าส่วนหัวการตอบกลับ Sunset HTTP : ส่วนหัว HTTP เล่นส่วนทางเทคนิคของคำเตือนผู้บริโภค API ควรตรวจสอบรหัสประเภทนี้เพื่อทำความเข้าใจเมื่อ API เลิกใช้แล้ว

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

นอกเหนือจากคำตอบที่มีอยู่คุณควรให้การแทนที่แบบดรอปดาวน์หรือแผนการย้ายข้อมูลเมื่อทำการลบบางอย่างเพื่อให้ผู้ใช้ของคุณสามารถอัปเดตรหัสได้

พยายามหลีกเลี่ยงการลบฟังก์ชันการทำงานโดยไม่ให้ทางเลือกอื่นซึ่งจะทำให้ผู้ใช้บางคนไม่มีความสุข