設(shè)計(jì)API的十條準(zhǔn)則

楊竹青

API是接口 - API本身并不實(shí)現(xiàn)任何功能，它只是一個(gè)接口定義（想想ActionScript中的Interface）。這是API最重要、最明顯的特點(diǎn)，也是API的目的所在。無論何種情況，請將這一點(diǎn)牢記于心
API不是代碼庫 - 一個(gè)好的API一定有明確的功能目的。它絕不是一堆函數(shù)（function）原型（prototype）的集合
公開的API能不改變則不改變 - 當(dāng)這些API對外發(fā)布之后，要想改變是非常痛苦的（你必須通知所有的使用者），因此在設(shè)計(jì)之前，一定要三思，例如方法名、參數(shù)類型，返回類型，等等。
API是神秘的 - API應(yīng)該把所有對外不必知道的信息全部封裝起來。例如使用者向我提問："你是一個(gè)天才么？"，我應(yīng)該回答"我是一個(gè)天才"，但不要回答"我為什么是一個(gè)天才"。
關(guān)注你的API的使用者 - API真正投入應(yīng)用才是健康的。要關(guān)注那些應(yīng)用你的API開發(fā)各種有趣應(yīng)用的代碼。
不要迷信文檔 - 好的API是一眼就能看明白的，不要指望那些渴望利用你的API做些小應(yīng)用的開發(fā)者會耐心地花幾個(gè)小時(shí)在你的文檔上
文檔、存檔很重要 - 雖然剛才提到不能依賴與文檔，但是作為API本身的開發(fā)者，一定要重視，因?yàn)槟阕约罕仨毟闱宄��?nèi)部的機(jī)理，這樣便于日后的維護(hù)和擴(kuò)展
要講誠信 - 不要為了取悅一部分人而讓另一部分人不知情，這是非�？膳碌�。我們越來越生活在一個(gè)開發(fā)、自由、透明的時(shí)代。有任何問題，就坦誠說出來。
沒必要來什么"驚喜" - 優(yōu)秀的API一定是"可預(yù)見的"，也就是說，開發(fā)者在閱讀你的API說明時(shí)，就已經(jīng)知道哪些應(yīng)用可以做，哪些應(yīng)用不可以做了，不要讓開發(fā)者開發(fā)到一半突然發(fā)現(xiàn)有一個(gè)新的應(yīng)用。那不是對開發(fā)者的肯定，反而是對這套API的諷刺。
要快樂 - API的工作是需要付出責(zé)任心并且邏輯嚴(yán)謹(jǐn)?shù)摹５�是千萬不要喪失一個(gè)最重要的原則："快樂"！要快樂，要認(rèn)識到你這套API能給你帶來的快樂和成就感！