用戶體驗是采用的關鍵，如果沒有人了解如何使用你的產品，他們就不會購買，這在 API 領域也是同樣的道理，開發人員更有可能采用并堅持使用他們喜歡使用的平臺或服務，因此， API 成功的關鍵是開發人員體驗，
**但什么是開發者體驗？ **
就像針對傳統消費者的產品一樣，API 的可用性是關鍵，因此，開發人員體驗是開發人員在與平臺互動時擁有的所有體驗的總和，在業務、技術和用戶體驗的交叉點上，平臺的開發人員體驗可能會成就或破壞組織在當今競爭例外激烈的技識訓境中的發展，
“良好”的開發者體驗就是理解和滿足客戶的需求，為此，還必須了解客戶是誰，許多軟體組織犯的一個錯誤是誤解了他們的受眾是誰，API不僅需要易于技術受眾使用，還需要 API 決策者易于使用，因為盡管他們的技術水平通常較低，但他們將決定團隊最終是否采用你的平臺，
API 檔案
API 檔案在消費者旅程的最后階段至關重要，在這些最后階段，潛在用戶會希望接觸API，但是如果沒有人了解如何使用API，他們就不會采用它；因此，無論讀者是誰，都必須確保API檔案清晰易懂，希望確保在閱讀 API 檔案后，開發人員和決策者都沒有懸而未決的問題，可以通過以下幾個簡單的步驟來確保這一點：
列出基本原理
具體來說，請確保清楚地解釋身份驗證、錯誤、結束點、使用條款和更改日志，為以上所有內容提供示例，并確保它們包含在正確的背景關系中，
解釋請求-回應周期
不要把任何東西留給用戶的想象，API檔案應包括完整示例回應正文，包括可能出現的任何錯誤，提供示例和用例以進一步闡明可能的場景，
通過測驗賦能
實驗就是力量！允許開發人員測驗 API，以便他們在采用 API 之前就可以發現API的價值，為此，請提供“入門”指南、SDK、教程以及互動式檔案和控制臺，
如果沒有時間撰寫 API 檔案，可以使用API工具如Eolinker，它允許用戶自動生成檔案，
如需了解更多與Eolinker有關資訊，請訪問:www.eolinker.com
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/296266.html
標籤：其他