構建api是很困難的。除了與業務涉眾舉行長時間的會議、選擇正確的技術堆疊以及構建適當的資料分發模型之外，還有許多更精細的細節可能被忽略。在21世紀的api大運動之後——隨著社交**的出現和移動技術應用的**式增長——更多組織已經意識到api帶來的增長機會。 但是要小心你的api。它可能是你最好的朋友，但也可能是你最大的負擔。在使用api時，糟糕的使用者體驗將導致沒完沒了的支援呼叫，隨之而來的是糟糕的聲譽，這可能會使您的服務變得不被信任。所以在你真正開始實現你的api之前，計畫，計畫，再計畫是很重要的。這就是restful api描述格式（如openapi規範和api藍圖）的設計和驚人威力的地方。
當我第一次聽到這個術語時，我認為它意味著以一種美觀的方式編寫語法和**。雖然這是它的一部分，但api設計涉及的遠不止編寫語法的方式。設計api意味著提供乙個有效的介面，幫助api的使用者更好地理解、使用和整合api，同時幫助您有效地維護api。每個產品都需要使用手冊，你的api也不例外。api設計應包括： 資源結構 資源文件
api的設計是api想要實現的目標的堅實藍圖，它全面描述了所有端點以及與每個端點相關聯的crud操作。有效的api設計可以極大地幫助實現和防止複雜的配置、堅持類內的命名模式，以及許多其他問題，這些問題可能會讓您持續數天。設計過程還將幫助你思考資料將如何分布以及你的核心產品將如何工作。
api開發是乙個持續的過程。任何不這麼想的公司都沒有充分利用api的潛力。隨著你的產品和服務的發展，你的api也應該發展。擁有乙個清晰的設計可以幫助您的組織和團隊準確地知道哪些資源或子資源需要更新，防止混亂和混亂。api越大，就越難管理它。設計良好的api可以防止重複工作，並幫助開發人員準確地知道哪些資源需要更新，哪些資源應該刪除。
文件對於構建讓api被使用的介面至關重要。在許多情況下，只有在繪製出api的資源和響應-請求週期之後，才能完成全面的文件。堅實的初始結構可以讓負責文件處理的人員更快地編寫api文件，並且更少出錯。文件過程可以通過出色的設計進行自我優化，在其上構建乙個全面的介面。
開發人員經驗是至關重要的。如果您是一名開發人員，那麼您可能不得不與乙個使您想要破壞計算機的服務進行工作和整合。我們都經歷過這樣乙個web服務，它讓我們在stackoverflow和reddit上花費了無數個小時，試圖弄清楚如何使用它。乙個好的api設計可以讓最終開發人員的生活變得輕鬆。它很快就能理解，所有的資源都組織得很好，互動很有趣，也很容易理解，所以使用你的api的人會有完美的使用體驗。
良好的api設計可以提高api的可用性，從而提高api的使用率，減少麻煩，提高api的成功機率。雖然我已經闡述了api設計的重要性，但實踐起來可能很難。高效的設計需要實踐。接下來我也會嘗試列出一些設計api時的優秀實踐，或者可以直接登入eolinker的**檢視幫助文件和自己嘗試使用。 **：www.eolinker.com
RESTful 風格 API 設計規範
建議將api部署到專用網域名稱下,如 如果不需要考慮擴充套件可以將api當做乙個模組來開發 建議將版本放入url位址中,如 v1.1 get 獲取資源 post 新建資源 delete 刪除資源 put 更新資源api應該提供引數,比如分頁,在pc端和移動端可能是不一樣的 比如pc端一頁 30 條資...
基於HTTP標準協議的API介面設計規範構思
版本控制git 開發流程git flow 請求方式 url動作 中文說明 get resources list 列表post resources create 建立get resources idretrieve 詳細put resources idupdate 更新patch resources ...
Web端設計規範的價值
1.可復用性 有了完整的設計規範和對應的元件控制項。方便視覺和互動設計師反覆復用，不需要重複製作，減少工作量提高工作效率。2.統一性 有了統一的設計規範，設計師之間使用時，可避免自我創造元件控制項，保持團隊產品的統一性體驗。3.提公升能力 由於元件控制項的可復用，這直接使設計師的工作效率得到極大提高...