API開(kāi)發(fā)體驗(yàn)是一個(gè)相對(duì)較奇特的關(guān)注點(diǎn)，之所以受到關(guān)注，是因?yàn)檫@樣的體驗(yàn)?zāi)芴岣逜PI的程序設(shè)計(jì)水平，當(dāng)開(kāi)發(fā)者在編寫(xiě)程序的時(shí)候，夯實(shí)無(wú)縫的開(kāi)發(fā)體驗(yàn)是多么的重要，不但能幫助程序員提高編程效率，還能讓開(kāi)發(fā)人員站在終端用戶(hù)的角度來(lái)實(shí)現(xiàn)功能目標(biāo)。

Jeremiah Lee Cohick是Fitbit公司的一名工程師，對(duì)較為廣泛的開(kāi)發(fā)體驗(yàn)（DX）領(lǐng)域里的用戶(hù)體驗(yàn)、框架API體驗(yàn)有著特別的理解和感受。DX包括程序員和他們的開(kāi)發(fā)平臺(tái)之間的多方面關(guān)系，如信任、教育、工具和平臺(tái)的可用性等等。需要特別強(qiáng)調(diào)的是，Cohick將“API體驗(yàn)”直接描述為“API用戶(hù)體驗(yàn)”，這種體驗(yàn)上的轉(zhuǎn)變最終會(huì)演變成開(kāi)發(fā)階段影響編寫(xiě)代碼的關(guān)鍵部分。在曾舉辦的一次Web Directions大會(huì)上，Cohick在演講中就明確定義了可達(dá)到API卓越目標(biāo)的四個(gè)關(guān)鍵部分：

• 功能性：通過(guò)API能夠解決什么問(wèn)題這一過(guò)程就能看出API的價(jià)值所在。有用的API體驗(yàn)除了要努力而有效地解決一個(gè)問(wèn)題之外，還應(yīng)該超乎想象的將問(wèn)題解決。
• 可靠性：合理的API一定要具備類(lèi)似可用性、可擴(kuò)展性、穩(wěn)定性等這樣的非功能性特征才是完美的，因?yàn)檫@些特征能夠幫助開(kāi)發(fā)者團(tuán)隊(duì)建立信任感，并代表一種必須的元素來(lái)驅(qū)動(dòng)開(kāi)發(fā)人員使用API。
• 可用性：API如何很好的通過(guò)自我感知的條件去發(fā)現(xiàn)和了解自己的功能？這個(gè)API在開(kāi)發(fā)者輕松地創(chuàng)建測(cè)試過(guò)程中是不是很輕便、智能？而且在錯(cuò)誤處理這一流程中又能提供哪些支持呢？這些都是考核API可用性的指標(biāo)。
• 舒適性：一個(gè)API如何能給開(kāi)發(fā)者一種這次用過(guò)了下次還想用的快感？

根據(jù)Cohick所說(shuō)的，一旦API具備了上述所有的必選條件，其給開(kāi)發(fā)者帶來(lái)的是非同凡響的開(kāi)發(fā)體驗(yàn)；相反，缺失某一特征或者存在明顯的紕漏都將是給開(kāi)發(fā)者帶來(lái)痛苦和混亂的根源。

就職于Intel Mashery的產(chǎn)品負(fù)責(zé)人Amit Jotwani說(shuō)，和API開(kāi)發(fā)相關(guān)的人群確實(shí)應(yīng)該認(rèn)認(rèn)真真的對(duì)待開(kāi)發(fā)者體驗(yàn)這一事。下面是他給出的創(chuàng)建偉大API體驗(yàn)的十個(gè)步驟：

• 盡量保持簡(jiǎn)單。
• 避免將營(yíng)銷(xiāo)術(shù)語(yǔ)用在API程序里，同時(shí)還要明確說(shuō)明，開(kāi)發(fā)者在使用這個(gè)API的時(shí)候哪些功能是可以隨時(shí)關(guān)掉的！
• 整體簡(jiǎn)潔、快速登錄，此外在API Key和服務(wù)選項(xiàng)的管理上力求簡(jiǎn)單。
• 快速設(shè)置，理想情況下，只需5分鐘就能創(chuàng)建一個(gè)“Hello World”App。
• 提供快速被用開(kāi)發(fā)的API Key，以此縮短長(zhǎng)等待時(shí)間。
• 明確了成本和限制條件，不要?jiǎng)?chuàng)造過(guò)高的期望，還要提供免費(fèi)試用。
• 提供長(zhǎng)期性的完整文檔，定期更新，并避免使用PDF格式。
• 必須提供交互式文件，如Mashery API Explorer和Klout交互式控制臺(tái)，這些都能幫助開(kāi)發(fā)者更容易發(fā)現(xiàn)和了解API。
• 顯示代碼，給出清晰簡(jiǎn)明的使用API方式的例子。
• 鼓勵(lì)開(kāi)發(fā)人員在例如Stack Overflow和Twitter等渠道里分享自己的經(jīng)驗(yàn)、心得。

根據(jù)API Academy公司的API設(shè)計(jì)主管Ronnie Mitra的說(shuō)法，多數(shù)咨詢(xún)公司幫助各種開(kāi)發(fā)組織改善API性能，API體驗(yàn)已經(jīng)開(kāi)始能夠識(shí)別開(kāi)發(fā)者了。想要?jiǎng)?chuàng)造一個(gè)優(yōu)良的DX，應(yīng)該先設(shè)定為四個(gè)關(guān)鍵目標(biāo)：

• 協(xié)助排除故障（e.g.提供有用的錯(cuò)誤信息）
• 簡(jiǎn)化修繕管理（e.g.推出API版本控制策略）
• 提高可視性（e.g.提供日志和使用訪(fǎng)問(wèn)權(quán)限）
• 建立信任關(guān)系（e.g.傳達(dá)一種穩(wěn)定而長(zhǎng)久的感覺(jué)）

在Stockholm 舉辦的API大會(huì)上，Mitra提出了一個(gè)框架設(shè)想，類(lèi)似于Cohick之前幫助設(shè)計(jì)的偉大API，其設(shè)想里的API主要有三大支柱：功能性、可用性和體驗(yàn)。在這種情況下，可用性將關(guān)注的焦點(diǎn)從功能性/可靠性轉(zhuǎn)移到開(kāi)發(fā)者身上，旨在幫助API更易于使用。體驗(yàn)涉及到開(kāi)發(fā)者對(duì)所有的API交互有一種什么樣的感覺(jué)，而且這種體驗(yàn)是建立在功能性和可用性基礎(chǔ)之上的。

Mitra還說(shuō)，要想提供一個(gè)優(yōu)異的API體驗(yàn)，關(guān)鍵點(diǎn)在于要深入理解它的最終用戶(hù)，決不能閉門(mén)造車(chē)出門(mén)不合轍。其實(shí)這可以通過(guò)給不同的、典型的API用戶(hù)進(jìn)行重新定義就能搞清楚。

如果你不知道誰(shuí)將會(huì)使用你創(chuàng)造出來(lái)的API，你根本沒(méi)有辦法設(shè)計(jì)API的可用性。

一旦決定確定之后，API的可用性方面可以通過(guò)幾個(gè)維度估算出來(lái)，原理是基于在微軟工作的Steven Clarke提出的理論：

• 調(diào)用比：在執(zhí)行任務(wù)的時(shí)候，API能為開(kāi)發(fā)者調(diào)用多少次？
• 結(jié)構(gòu)：所需數(shù)據(jù)有多深？噪音比的信號(hào)是什么？
• 導(dǎo)航：從一個(gè)結(jié)果轉(zhuǎn)移到另一個(gè)結(jié)果有多困難？定位所需的數(shù)據(jù)多少難度？
• 開(kāi)發(fā)堆棧大小：需要多少個(gè)新組件？
• 第一次調(diào)用：一個(gè)新用戶(hù)如需執(zhí)行第一次API調(diào)用，需要多少時(shí)間？
• 錯(cuò)誤：修復(fù)一個(gè)錯(cuò)誤很難做到么？錯(cuò)誤的本質(zhì)是什么？

同樣，API體驗(yàn)提供了以下幾個(gè)方面：參與、快感、熟悉、信任和安全，這些方面都能指導(dǎo)設(shè)計(jì)整個(gè)開(kāi)發(fā)的全過(guò)程。最重要的是，上面提到的這幾個(gè)方面都是API高可用性質(zhì)量的直接體現(xiàn)。

本文轉(zhuǎn)自