到目前為止，已經負責api接近兩年了，這兩年中發現現有的api存在的問題越來越多，但很多api一旦發布後就不再能修改了，即時公升級和維護是必須的。一旦api發生變化，就可能對相關的呼叫者帶來巨大的代價，使用者需要排查所有呼叫的**，需要調整所有與之相關的部分，這些工作對他們來說都是額外的。如果辛辛苦苦完成這些以後，還發現了相關的bug，那對使用者的打擊就更大。如果api經常發生變化，使用者就會失去對提供方失去信心，從而也會影響目前的業務。
但是我們為什麼還要修改api呢？為了api看起來更加漂亮？為了提供更多功能？為了提供更好的效能？還是僅僅覺得到了改變了時候了？對於使用者來說，他們更願意使用乙個穩定但是看起來不那麼時髦的api，這並不意味著我們不再改進api了。當糟糕的api帶來的維護成本越來越大時，我想就是我們去重構它的時候。
如果可以回頭重新再做一遍，那麼我心目中的優秀的api應該是怎麼樣的？
判斷乙個api是否優秀，並不是簡單地根據第乙個版本給出判斷的，而是要看隨著時間的推移，該api是否還能存在，是否仍舊保持得不錯。槽糕的api介面各種各樣，但是好的api介面對於使用者來說必須滿足以下幾個點：
而對於開發人員來說，要求又是不一樣的：
如何做到以上幾點，以下是一些總結：
1、 面向用例設計
如果乙個api被廣泛使用了，那麼就不可能了解所有使用該api的使用者。如果設計者希望能夠設計出被廣泛使用的api，那麼必須站在使用者的角度來理解如何設計api庫，以及如何才能設計出這樣的api庫。
2、 採用良好的設計思路
在設計過程中，如果能按照下面的方式來進行設計，會讓這個api生命更長久
除此之外，下面還列出了一些具體的設計方法：
3、 避免極端的意見
在設計api的時候，一定要避免任何極端的意見，尤其是以下幾點：
4、 有效的api評審
api設計完成以後，需要經過周密的設計評審，評審的重點如下：
5、 提高api的可測試性
api需要是可測試的，測試不應依賴實現，測試充分的api，尤其是經過了嚴格的「相容性整合測試」的api，更能保證在公升級的過程中不出現相容性問題。相容性整合測試，是指一組測試用例集合，這組測試用例會站在使用者的立場上使用api。在api公升級以後，再檢測這組測試用例是否能完全符合預期的通過測試，盡可能的發現相容性問題。
6、 保證api的向後相容
對於每乙個api的設計者來說，都渴望做到「向後相容」，因為不管是現在的api使用者，還是潛在的api使用者，都只信任那些可相容的api。但向後相容有多個層次上的意義，而且不同層次的向後相容，也意味著不同的重要性和複雜度。
7、 保持逐步改善
過去我們總希望能將現有的「不合理」的設計完全推翻，然後按照現在「美好」的思路，重新設計這個api，但是在一段時間以後，又會碰到一樣的狀況，需要再推翻一次。 如果我們沒有有效的逐步改善的辦法，依靠推翻現有設計，重新設計api只能讓我們回到起點，然後重現之前的過程。 要有一套行之有效的持續改善的辦法來在api相容的同時，改善api使之更好。
8、 把握api的生命週期
每乙個api都是有生命週期的，我們需要讓api的生命週期更長，並且在api的生命週期結束時能讓其平滑的消亡。
開發api的過程其實就是乙個溝通交流的過程。溝通的雙方就是api使用者和api設計者。
9、 一些具體的實施方案
在乙個api不可避免要消亡或者改變的時候，我們應該接受並且面對這個事實，下面列舉了幾種保證相容性的前提下，對api進行調整的辦法：
一些好的api示例：
flickr api，這裡是文件的示例，同時提供了乙個非常方便的api測試工具。
mediawiki api
ebay api，這裡有乙個非常詳盡的文件示例。
如何設計乙個優秀的API
判斷乙個api是否優秀，並不是簡單地根據第乙個版本給出判斷的，而是要看隨著時間的推移，該api是否還能存在，是否仍舊保持得不錯。槽糕的api介面各種各樣，但是好的api介面對於使用者來說必須滿足以下幾個點 易學習 有完善的文件及提供盡可能多的示例和可copy paste的 像其他設計工作一樣，你應該...
如何快速設計乙個優秀秒殺系統
1 什麼是秒殺 秒殺場景一般會在電商 舉行一些活動或者節假日在12306 上搶票時遇到。對於電商 中一些稀缺或者 商品，電商 一般會在約定時間點對其進行限量銷售，因為這些商品的特殊性，會吸引大量使用者前來搶購，並且會在約定的時間點同時在秒殺頁面進行搶購。2 秒殺系統場景特點 秒殺時大量使用者會在同一...
乙個簡單API設計
用乙個紅綠燈來學習jsapi的設計 css trafficlight li trafficlight span trafficlight.stop li nth child 1 span trafficlight.wait li nth child 2 span trafficlight.pass ...