根據資料和經驗總結。

要求：

命名：

命名規則和風格統一、規范；

命名清晰明確，不冗余，不模糊；

有意義：清晰和有意義的命名比簡略而模糊的命名更應受到青睞；

功能

職責明確：功能盡量單一；

充分理由：不要隨便有新功能就增加新接口；無意義的接口只會增加維護的難度；

將功能層和策略層分開：

功能是基礎數據，不易變；

策略是表層數據，易變——策略可以使用參數修改；

低耦合：減少不同接口間的依賴。

一個接口不應隨著另一個接口的變化而變化；

一個接口不應以某幾個接口為前提而存在。

完備性：

考慮各種參數變化的情況；

考慮各種參數為default或為0的情況；

可擴展性：為以后可能會增加的參數預留余地，盡量不要寫死；

參數

不超過5個；

從做到右，按照參數容易變化的程度排列；

盡量提供默認值；

若超過5個，把相似的數據放入到一個json或list等數據結構中；

禁止隨意擴展：理由見“功能”部分；

參數盡量是原生數據結構，少用對平臺依賴的數據結構。

分析角度：明確角度，不要一會以角色設計，一會以功能設計。

必要信息：

初始信息

初始化是否完畢

初始化完畢后的基本信息（如：list或dict的長度——可以看出是否為0）

中間信息

數據源是否變動

數據長度是否改變（需要視重要程度決定是否需打印該信息）

返回信息

是否成功？

失敗原因？

?

?

?

參考文獻：

http://www.yixieshi.com/zhichang/14567.html

總結

以上是生活随笔為你收集整理的如何设计接口的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。