主題 12 實踐案例集錦之介面設計

2021-10-25 08:31:04 字數 712 閱讀 9094

api 是模組或者子系統之間互動的橋梁,好的系統架構離不開好的 api 設計。在《主題 1:如何設計乙個好的 api》一文中,筆者解讀了什麼樣的 api 設計是好的設計,本文作為 api 設計話題的延續,將介紹如何在設計中實踐之前介紹的設計方**。

成功的系統不是有一些特別閃光的地方,而是設計時點點滴滴的努力積累起來的。

api 設計面臨的挑戰千差萬別,沒有一種普適性的原則可以適用於所有場景,因此,即便是久經考驗的設計原則和最佳實踐,本身也一定有適應的場景和不適應的場景。鑑於此,筆者在介紹一些設計原則的同時也會分析這些原則在什麼場景下適用,以便讀者在實踐中可以有針對性地採取例外的策略。

2.1 思維模型清晰

很多任務程師有乙個誤解——api 設計的關鍵在於讓客戶端與服務端進行良好地互動。這種認識忽略了乙個重要的因素——人(包括 api 的設計者、維護者、使用者),事實上,api 設計的關鍵應是讓 api 相關的工程師群體在 api 生命週期內良好地進行互動。乙個 api 如何被使用,以及 api 本身如何被維護,依賴於維護者和使用者對該 api 有清晰的、一致的認識,而要達到這一目標,就需要設計者提供乙個清晰的、易於理解的模型。

如下圖所示,從 api 設計者的角度,他設計了乙個模型 a;而從使用者的角度,他看到和理解的模型可能會退化成模型 b,如果這個模型比較複雜,在實際使用過程中可能進一步退化成 c;對於維護者來說,也存在相似的問題。

主題 12 實踐案例集錦之設計理念

古語云 道為術之靈,術為道之體 以道統術,以術得道。其中 道 指 規律 道理 理論 術 指 方法 技巧 技術 意思是 道 是 術 的靈魂,術 是 道 的肉體 可以用 道 來統管 術 也可以從 術 中獲得 道 工匠追求 術 到極致,其實就是在尋 道 且離悟 道 也就不遠了,亦或是已經得道,這就是 工匠...

Android Note(一) 主題介面設計

生活是非常忙碌的,所以我們會經常性的忘記一些事情,所以乙個完美的記事本就非常需要了。一方面,可以記錄我們的美好回憶,一方面,可以做個鬧鐘,然後按時提醒我們即將做什麼事情。所以,我們就一步一步的實現這個記事本的 開發,希望對其有所幫助。首先,我們介紹一下記事本的功能,1 在主介面新增鬧鐘,然後開啟新建...

API介面設計最佳實踐

目錄 目錄前言 api介面設計 token設計 api介面設計原則 1 明確協議規範 2 統一介面路徑規範 3 統一介面版本管理 4 為你的介面設定呼叫門檻 5 介面返回規範 6 介面安全規範 7 冪等性 8 介面設計的一些最佳實踐 api介面管理 最近團隊內部在做故障覆盤的時候發現有很多故障都是因...