接口設計需要注意的地方
一、接口版本化
生產環境中，如果沒有版本控制的程序變更會導致調用接口的相關方頻繁的跟着變更，假設相關方沒有及時的跟着變更，那麼系統就會報錯，從而影響到用戶的使用及體驗，使其對整個系統的運營都是不利的，接口對接的難度也會不斷的加大。
如果接口能夠有版本的控制，則升級系統的主動權就掌握在相關方，這樣當有新版本的程序發佈時舊版本的業務邏輯不會受到影響，從用戶感知上也受到的影響就比較小，相關方也可以根據自身的條件是否要升級版本。
二、接口面向的應用場景
在對接口進行設計時，我們還要考慮接口是面向web前端開發還是手機app開發，或者服務端開發。不同的應用場景接口總體規劃是不同的（例如：當我們的接口是提供給web前端或APP端使用時，接口安全驗證我們可以採用jwt、oauth2.0等，如果我們的接口是提供給後端服務使用時，那麼我可以採用token機制）。
三、請求參數的規範性及處理的統一性
請求參數的規範性意思就是說，接口要以什麼樣的方式來接收參數。是統一使用json的方式接收呢還是xml或者form表單方式接收。
在開發接口應該統一在一個地方進行對參數的接收、校驗等操作。爲了保證參數的完整性，我們可以考慮新增簽名驗證等處理。
四、返回數據類型、返回碼及信息提示的規範性
返回給客戶端的數據類型應該要統一化（例如：我們統一以json的形式進行返回，或者是統一以xml的形式返回）。
不同的接口設計模式返回碼也會不同，如果使用現在非常火也比較流行的restfull風格那麼就應該要准許restfull風格的返回碼規定。如果是統一採用自定返回碼的話在設計返回碼時，應該要學會針對不同的業務處理模塊對返回碼進行分段處理（例如：系統基礎管理我們使用10000-10050，用戶管理則就應該要從10051到10100，……），針對不同業務模塊我們要預留足夠的返回碼，因爲後期針對該模塊的開發可能還會有其它業務的擴展或者調整等問題。返回碼分段處理的一個好處就是方便調用接口的相關方能夠很快的定位到錯誤是屬於哪一個部分，同時也方便接口開發人員定位接口錯誤在哪個地方。
除了返回碼，我們對接口返回的錯誤提示信息和接口調用成功的提示信息都應該明確，提示到點上。當然有些錯誤信息可能是自身API的bug或者服務器的問題等因素，這樣的話我們就應該要轉化一下提示不能把API自身問題暴露給接口調用相關方，這樣會導致接口的安全性等問題。
五、接口安全驗證及權限的控制
接口並不是每個操作者都能請求訪問的，所以我們要爲接口提供一個安全驗證，就像用戶登錄系統一樣，沒有在我們系統註冊的合法用戶我們是不允許請求訪問的。那麼我們要如何對接口進行安全驗證呢？其實針對不同的應用場景我們的接口安全驗證也不一樣（例如：當我們的接口是提供給web前端或APP端使用時，接口安全驗證我們可以採用jwt、oauth2.0等，如果我們的接口是提供給後端服務使用時，那麼我可以採用token機制）。
權限的控制是指針對不同的用戶羣體，我們要分配不同的權限（例如：超級管理員可以操作所有接口，普通用戶只允許操作部分接口），這裏除了針對用戶羣體我們可以針對不同的調用接口的相關方（這裏的相關方是指調用接口的應用）進行權限控制。
六、接口調用頻率的控制
對接口的調用頻率進行控制從另一方面來講也是爲了接口的安全性及接口的可維護性，當然這裏是否要對接口訪問次數進行控制還是取決於接口針對不同的應用場景，有些接口的設計是不需要限制調用頻率的，而有些接口則對接口調用是要進行嚴格控制的（例如：大家熟知的微信公衆號的開發就是對接口的調用頻率進行限制，並且針對不同的場景及用戶羣體限制的頻率也不一樣）。
七、請求接口日誌的記錄
我們應該要爲接口請求做一下日誌的記錄，這樣我們後期維護接口時則會大大降低維護成本。而且還可以針對日誌進行相關的統計處理。
八、接口文檔的可讀性
接口文檔的可讀性非常重要，一個接口開發出來並不是真正的完成，如果別人不會使用你的接口，那麼你的接口開發出來也是沒有用的，好多程序員非常的不重視接口文檔撰寫及接口文檔可讀性，寫出來的文檔就像一本天書看着就頭大。好的文檔應該讓人一看就知道如何調用，如何規避一些坑，簡單明瞭等等。這裏我介紹兩個比較好的接口管理可視化工具給大家參考一下swagger和阿里巴巴的rap。
九、接口的響應時間
對於重要的接口要採用壓測的方法去確認該接口的性能，避免在高訪問量來臨時，導致整個服務癱瘓。
十、接口返回的數據量
如果一個接口返回的數據量要有一定的預測，如果太大會影響到整體性能。
十一、接口中是否有調第三方接口
調用第三方接口，需要考慮調用失敗的重試次數，並打印調用失敗的日誌，方便後續分析問題。
int i = 0;
retry
while (true) {
//調用第三方接口
if (result) {
break retry;
} else {
if (i == 3) {
break retry;
}
continue retry;
}
}
轉載於該博客：https://blog.csdn.net/Dorisnzy/article/details/80882144
高可用接口:https://blog.csdn.net/gitchat/article/details/78705978