Restful Api介面規範

2021-08-11 22:37:17 字數 602 閱讀 7627

用名詞代替動詞表示資源

get /employees

get /employees?state=external

post /employees

put /employees/56

對可選的、複雜的引數,使用查詢字串(?)。

get /employees?state=internal&maturity=senior

非資源請求用動詞

有時api呼叫並不涉及資源(如計算,翻譯或轉換)。例:

get /translate?from=de_de&to=en_us&text=hallo

get /calculate?para2=23¶2=432

考慮特定資源搜尋和跨資源搜尋

提供對特定資源的搜尋很容易。只需使用相應的資源集合url,並將搜尋字串附加到查詢引數中即可。

get /search?query=paul //返回 employees, customers, suppliers 等等.

RESTful api介面規範

整體規範建議採用restful 方式來實施。協議api與使用者的通訊協議,總是使用https協議,確保互動資料的傳輸安全。網域名稱應該盡量將api部署在專用網域名稱之下。如果確定api很簡單,不會有進一步擴充套件,可以考慮放在主網域名稱下。api版本控制 應該將api的版本號放入url。v 另一種做...

RESTful api介面規範

restful api 的設計規範 restful 介面規範 整體規範建議採用restful 方式來實施。協議api與使用者的通訊協議,總是使用https協議,確保互動資料的傳輸安全。網域名稱應該盡量將api部署在專用網域名稱之下。如果確定api很簡單,不會有進一步擴充套件,可以考慮放在主網域名稱下...

RestFul API介面規範

整體規範建議採用restful 方式來實施 協議 api與使用者的通訊協議,總是使用https協議,確保互動資料的傳輸安全。網域名稱 應該盡量將api部署在專用網域名稱之下。如果確定api很簡單,不會有進一步擴充套件,可以考慮放在主網域名稱下。api版本控制 應該將api的版本號放入url。v 另一...