最新公司新的專案,使用spring boot,cloud,服務之間使用rest api進行呼叫,所有使用了restful 風格的介面
@responsebody
public objectrestresponse> getbyregionid(@pathvariable("regionid") string regionid) {}
@responsebody
public objectrestresponse modifymenuauthority(@pathvariable string id) {}
利:介面名稱相同,請求method,通過requestmethod.get/post/put/delete來區別,就可以實現增刪改查
弊:前端傳參不方便,如在請求位址中拼接,如果regionid為空,就會出錯.
如 ,通過表單引數post,或get位址列引數傳regionid,如
.com/getbyregionid?id=x232323
單詞要使用英文來命名，不要拼音英文混合,不要英文簡寫,除非這個簡寫大家都認識
同一名稱不同人名稱要相同
名稱可以長一些,單不要有歧義
介面規範 API介面
同通過網路，規定前後臺資訊互動規則的url連線，是前後臺資訊互動的媒介。1 url 2 請求方式 get post put patch delete 3 請求引數 json或xml格式的key value型別資料 4 響應結果 json或者xml格式的資料 編寫介面文件可以使用去哪網技術中心的乙個開...
API介面規範
對於資源的具體操作型別，由http動詞表示。常用的http動詞有下面四個 括號裡是對應的sql命令 get select 從伺服器取出資源 一項或多項 post create 在伺服器新建乙個資源。put update 在伺服器更新資源 客戶端提供改變後的完整資源 delete delete 從伺服...
api介面規範
api與使用者的通訊協議，總是使用https協議，確保互動資料的傳輸安全。應該將api的版本號放入url。另一種做法是，將版本號放在http頭資訊中，但不如放入url方便和直觀。採用多版本並存，增量發布的方式 v n代表版本號,分為整形和浮點型 整形的版本號 大功能版本發布形式 具有當前版本狀態下的...