借助三大技巧 助你提升API狀態頁面

利用API創建應用有著巨大的優勢，但很多時候你并不了解為何/系統設備會“崩潰”，這也是API各大廠商積極提供可用狀態頁面的原因。

在上周舉辦的SXSW的音樂節上，研討會很大程度上都是依靠Twitter API。與會者在做報告時發生“意外”的錯誤現象，經盤查是因一個錯誤API導致的。前段時間，Twitter發生了宕機事件，而聯合創始人Biz Stone正在參加德克薩斯州的SXSW大會。Twitter出現大規模服務中斷，大量用戶無論是通過桌面網頁、移動網頁或移動應用均無法訪問網站。

我承認我不敢看Twitter的狀態頁面，似乎是性能部分被中斷了。從上圖中我們可以看到3月11號性能部分沒有任何信息。

良好的API狀態頁面

API狀態頁面應該確保能與開發者溝通，包括當前的、最近的問題。API提供商應該具備以下三點：

• 透明性
• 有用性
• 主動性

其中最為重要的是透明性。如果某家公司的API出現問題了，那么直接受影響的是開發者，接著就是影響所有用戶。作為一名開發者，我想了解這方面的信息，因為這將有助于我尋找解決方案。前提是只有掌握有用的狀態頁面信息才能搞清楚該做么做。

其次，良好的狀態頁面應該主動提供廠商信息。打個比方，我們需要恢復損壞的數據庫，此時獲取解決方案可能需要花上幾個小時而不是幾分鐘。

一個好的API狀態頁面應該有著明確的目標，讓我們來看看一些最受歡迎的API廠商所使用的策略：

1. 提供狀態更新

所有的圖表、圖形以及圖標都非常的顯著。信息圖是用的，但是從基礎層面講，你應該提供短且清晰的、易于理解的更新狀態。最好是利用簡單的文本更新列表。即便是小問題，也要張貼出告之用戶。

2. 顯示當前API的“健康“問題

當開發者進入狀態頁面時能立即判斷是否需要進一步調查。換句話說，此刻的API狀態健康嗎？

Facebook將當前的頁面信息放置在頁面中心，包括當前狀態以及狀態報告，你可以調用這些API。

Stripe的狀態頁面非常簡潔，即便是更新項目也無需加載頁面。

Twilio則列出了22個設備當前API狀態及以往狀態信息。

3. 回顧最近問題或宕機時間

針對透明性和有用性，API贊助商應當提供查看歷史API的狀態信息。例如，提供早前的24小時細節狀態信息可以幫助開發人員診斷出問題。與此同時，通過此前宕機API信息也可預測出潛在的風險。

以下是，Facebook顯示最近24小時里平均每小時的響應時間和錯誤率。

Stripe的數據可以追溯到90天。

GitHub通過七張圖表讓開發者深入挖掘過去的幾天、幾周或幾個月里API狀態。

如果開發者想依賴API創建應用，那么他們需要更多的了解執行細節。良好的API狀態頁面有助于顯示當前的或最近的API健康問題，幫助開發者作出更好的運行決策。

英文出自：Programmableweb

生活不易，碼農辛苦
如果您覺得本網站對您的學習有所幫助,可以手機掃描二維碼進行捐贈