代碼優雅，後期好維護，技術專家的目標

java開發、後端開發、軟件開發工程師、編程

參數資料

專家的API設計案例哪裡找，程序員們看下面

• 微信開發平臺API

• 美團外賣開發平臺接口

1， 接口參數類型定義

避免濫用String,

如日期類型就應該用Date，錢就用Money(自定義的類型)

複雜字段不要定義Map<string>儘量多創建DTO來描述複雜模型/<string>

很多接口程序員圖簡單快，上來就是Map搞定。

2， 接口新模型

必須多考慮，優先使用現有的模型（DTO），

如果需要新增，則模型的字段需要延續業務已經有的標準

（如：電影實例的字段需要和電影模板的一致）

所以新進一個項目組必須儘快熟悉目前的接口業務，很多接口能力本來就有了，然後你不熟悉導致又增加冗餘接口。

3， 接口需要滿足原子性

滿足原子性，避免有二義

如查詢併購買電影票，就不具備原子性

如微信API，如果搞個查詢並關閉訂單，這就不具備原子性

4 ，接口輸出模型職能匹配

職能匹配，不能有接口邊界不清楚，

如查看電影票接口，返回了電影優惠券，

就會導致接口邊界不清楚

5，儘量複用現有接口能力

如查詢電影數據接口，本身電影只支持查詢未被刪除的電影，

突然PD提出需要查詢已經刪除的電影數據，這個時候不是馬上新開一個接口

而是在原來接口DTO上增加區分是否刪除的屬性去控制，

後端SQL就通過DTO的刪除屬性去動態拼接SQL條件

6，接口參數模型嵌套不要太深

建議不要超過5層，儘量平鋪

7，接口推薦用json格式

json簡單速度快，推薦使用

大家設計接口可以去看看微信、支付寶的開發平臺API接口怎麼設計的

java開發、後端開發、軟件開發工程師、編程