提升API用戶體驗(yàn)：通用設(shè)計(jì)原則與網(wǎng)關(guān)工具的結(jié)合藝術(shù)

作者：youqing · 2024-08-27 · 閱讀時(shí)間：8分鐘

我們最近對也在使用 API 網(wǎng)關(guān)的客戶進(jìn)行了調(diào)查，并與其中一些人詳細(xì)討論了他們在 API 程序中使用的工具和流程。 這些用戶在許多不同的垂直市場、不同規(guī)模的團(tuán)隊(duì)以及處于各個(gè)成熟階段的公司中工作。盡管如此，無論是公司還是產(chǎn)品，技術(shù)領(lǐng)導(dǎo)者所看重的一些不變的主題仍然給我們留下了深刻的印象——工具需要是專門設(shè)計(jì)的、低摩擦的、可供技術(shù)和非技術(shù)利益相關(guān)者使用的，并且隨著時(shí)間的推移是可靠的。

至于為什么這些原則被如此廣泛地共享，我們認(rèn)為可以歸結(jié)為一個(gè)非常簡單的事情：良好的開發(fā)人員體驗(yàn)是良好的 API 產(chǎn)品設(shè)計(jì)的結(jié)果，而這需要支持您的工作的工具。當(dāng)您將有效的工具、設(shè)計(jì)優(yōu)先原則和產(chǎn)品思維結(jié)合起來時(shí)，您將獲得更流暢、更高效的開發(fā)人員和用戶體驗(yàn)。

如何使用通用設(shè)計(jì)原則構(gòu)建適應(yīng)性強(qiáng)的 API？

如果您從未聽說過“遏制效應(yīng)” ，那么您幾乎肯定是其受益者。當(dāng)公交車站和人行橫道首次強(qiáng)制設(shè)置輪椅坡道時(shí)，各種各樣的人都受益了——推著嬰兒車的父母、推著手推車的送貨司機(jī)，以及拖著行李去機(jī)場的人們。它已成為對某一群體所做的改進(jìn)通常如何為整個(gè)社會帶來好處的簡寫。

API是否有限制？您可以對 API 程序進(jìn)行哪些更改以使它們更易于訪問？這樣你能獲得一些意想不到的好處嗎？毫不奇怪，我們認(rèn)為這是可能的——并且設(shè)計(jì)優(yōu)先的 API 是實(shí)現(xiàn)這一目標(biāo)的途徑。

最普遍的無障礙方法之一是通用設(shè)計(jì)。它是一套產(chǎn)品和通信原則，旨在讓盡可能多的人在最廣泛的情況下可以訪問和使用。 UD 的全部范圍超出了我們在這里的時(shí)間，并且某些原則與軟件開發(fā)不太相關(guān)。但值得深思的是：UD 的目標(biāo)——構(gòu)建可用且足夠靈活的產(chǎn)品和程序，以滿足不同用戶的需求——絕對適用于 API 產(chǎn)品團(tuán)隊(duì)。

您無法準(zhǔn)確預(yù)測誰將使用您的 API 或他們將如何使用它們，甚至無法預(yù)測誰將構(gòu)建它們。 UD 原則可以幫助您創(chuàng)建具有耐用性、靈活性和吸引力的 API 程序。問自己以下有關(guān) API 的問題：

  1. 公平使用：我們是否提供歡迎所有潛在用戶的 API 入口點(diǎn)？我們可以在哪里消除障礙？
  2. 使用靈活性：我們是否支持 API 消費(fèi)者獲得成功的多種途徑？或者我們是否在不需要的地方規(guī)定了單一方法？
  3. 使用簡單直觀：用戶是否容易理解我們的 API 的用途？找到您需要的工具是否容易？我們是否明確了安裝和授權(quán)流程？
  4. 可感知的信息：我們的文檔是否使用簡單的語言，并提供清晰的功能示例和可導(dǎo)航資源？我們對用戶已經(jīng)知道的內(nèi)容做出什么假設(shè)？
  5. 錯(cuò)誤容忍度：不遵循我們首選路徑的用戶會發(fā)生什么？我們是否在應(yīng)用程序中提供有用的錯(cuò)誤消息？我們有支持故障排除的文檔嗎？
  6. 低（物理）工作量：我們是否提供簡單的方法來探索、測試功能和構(gòu)建試用集成？身份驗(yàn)證過程是否快速且可預(yù)測？用戶的痛點(diǎn)在哪里？我們是否在用戶流程中的任何地方造成了不必要的認(rèn)知負(fù)擔(dān)？
  7. 方法和使用的大小和空間：我們的 API資源可以與屏幕閱讀器一起使用嗎？它們的視覺組織方式是否適合低視力用戶管理？

API 為公共安全提供可靠、創(chuàng)新的 GIS 數(shù)據(jù)。

從 1995 年開始， GeoComm的創(chuàng)始人是最早將現(xiàn)代 GIS（地理信息系統(tǒng)）數(shù)據(jù)應(yīng)用于應(yīng)急響應(yīng)服務(wù)的人之一。此后，他們不斷創(chuàng)新，為公共安全機(jī)構(gòu)帶來更多、更好的位置數(shù)據(jù)，包括廣泛使用 API。

GeoComm 是一家高度專業(yè)化的公司，在最高風(fēng)險(xiǎn)的情況下處理關(guān)鍵任務(wù)數(shù)據(jù)。讓他們的精力集中在核心競爭力上至關(guān)重要。他們?yōu)楣膊块T機(jī)構(gòu)提供服務(wù)，努力保持低成本和精簡運(yùn)營，同時(shí)仍保持最高質(zhì)量的產(chǎn)品。他們對開源工具的質(zhì)量感到滿意，例如用于基于 Kubernetes 的應(yīng)用程序的 API 網(wǎng)關(guān)和托管 API 文檔的 Stoplight Elements。這些工具讓他們能夠管理成本并將精力投入到真正重要的事情上，這樣他們就可以提供更好的公共安全工具。

API 幫助公司轉(zhuǎn)型為移動解決方案提供商

普利司通是領(lǐng)先的輪胎制造商，自 1931 年開始營業(yè)。普利司通集團(tuán)在 150 多個(gè)國家和地區(qū)擁有約 130 家制造工廠和研發(fā)機(jī)構(gòu)，提供優(yōu)質(zhì)輪胎、解決方案、多元化產(chǎn)品和探索性業(yè)務(wù)。

普利司通的解決方案業(yè)務(wù)專注于在使用普利司通輪胎時(shí)為客戶增加價(jià)值。隨著越來越多的車輛在物聯(lián)網(wǎng)和 ICT 相關(guān)技術(shù)的幫助下實(shí)現(xiàn)互聯(lián)，生成有關(guān)車輛及其組件的數(shù)據(jù)，以幫助管理和減少停機(jī)時(shí)間。作為這一趨勢的一部分，輪胎也變得越來越互聯(lián)，有關(guān)輪胎相關(guān)性能的數(shù)據(jù)正在被收集。普利司通的目標(biāo)是結(jié)合其在輪胎設(shè)計(jì)和開發(fā)、擴(kuò)展服務(wù)范圍和數(shù)字平臺/應(yīng)用程序方面的領(lǐng)先專業(yè)知識，成為提取可行見解的最佳人選。

作為移動解決方案提供商，他們利用 API的強(qiáng)大功能與各種合作伙伴系統(tǒng)集成。為此，API 是其業(yè)務(wù)戰(zhàn)略的前沿和中心，這需要對整個(gè)端到端 API 計(jì)劃進(jìn)行徹底改造。這一廣泛舉措的一部分促使他們采用左移設(shè)計(jì)方法，在設(shè)計(jì)過程的早期采用更加以客戶為中心的 API 開發(fā)方法，讓內(nèi)部和外部利益相關(guān)者參與進(jìn)來。這種方法的好處包括提高開發(fā)速度、降低 API 返工成本以及共同價(jià)值創(chuàng)造。他們對 API 網(wǎng)關(guān)的選擇很簡單 – 他們選擇了云提供商的本機(jī)解決方案，因?yàn)樗亲钪庇^和一致的，并且可以輕松簡化跨團(tuán)隊(duì)的流程。

打開正確的門并提供一張好的地圖。

通用設(shè)計(jì)的那些原則——這些可幫助 API 團(tuán)隊(duì)解決以下每個(gè)要素：

  1. 網(wǎng)關(guān)有助于減少 API訪問的技術(shù)障礙，有助于確保您的文檔是最新的且易于訪問，從而改善公平使用。
  2. 網(wǎng)關(guān)和協(xié)作設(shè)計(jì)工具可幫助各種利益相關(guān)者通過單個(gè)可預(yù)測的界面與您的 API 產(chǎn)品互動，支持靈活使用。
  3. 明確設(shè)計(jì)用于簡化復(fù)雜系統(tǒng)并提高一致性的 API 工具將允許用戶直觀地在功能和產(chǎn)品之間移動。
  4. 網(wǎng)關(guān)工具旨在使您的 API 更加人性化，并重視將關(guān)鍵信息放在最需要的地方 – 一般來說，它們將不斷改進(jìn)可訪問性，以便您可以讓所有人都能感知信息您的 API 用戶。
  5. 雖然構(gòu)建具有容錯(cuò)能力的系統(tǒng)很重要，但使用 API 網(wǎng)關(guān)是為用戶建立明確的首選路徑并首先減少出現(xiàn)錯(cuò)誤的可能性的好方法。它可以幫助您有效地規(guī)劃路徑，而出色的文檔可以幫助用戶在不確定如何繼續(xù)時(shí)進(jìn)行導(dǎo)航。
  6. 正如上面的兩個(gè)示例所示，選擇正確的工具有助于減輕 API 團(tuán)隊(duì)的認(rèn)知負(fù)擔(dān)并消除壓力源 – 一旦就位，您的 API 工具應(yīng)該是輕松的工作，這樣您就可以專注于使用 API 創(chuàng)造價(jià)值。
  7. 這有點(diǎn)牽強(qiáng)，但即使是視覺組織方面的微小改進(jìn)，無論是通過網(wǎng)關(guān)、文檔還是 API 目錄，都可以通過為用戶提供查看 API程序不同部分的空間來提高生產(chǎn)力。清楚地。

我們建議考慮您的 API 工具，特別是您的設(shè)計(jì)工具、網(wǎng)關(guān)和文檔解決方案，為您的 API 利益相關(guān)者建立一條順暢的道路。用戶體驗(yàn)設(shè)計(jì)師使用“首選路徑”的概念來討論潛在用戶如何瀏覽網(wǎng)站或應(yīng)用程序。當(dāng)用戶遵循首選路徑時(shí)，他們會減少挫敗感，并更好地了解產(chǎn)品的功能及其提供的可能性。

開發(fā)者體驗(yàn)也是如此！您并不確切知道開發(fā)人員將使用您的 API 做什么，但您知道在探索之路上有更好和更差的方法。

原文鏈接：Pave a Smooth Path for API Stakeholders with Gateways