Restful介面規範

2022-04-10 22:32:31 字數 1244 閱讀 7247

2023年roy fielding博士在其博士**中提出rest(representational state transfer)風格的軟體架構模式後,rest就基本上迅速取代了複雜而笨重的soap,成為web api的標準了。

restful作為目前最流行的 api 設計規範,一定有著它獨有的魅力:強大、簡介、易上手。

2.1 資料的安全保障

2.2 介面特徵表現

2.3 多資料版本共存

2.4 資料即是資源

注:一般提倡用資源的複數形式,在url鏈結中盡量不要出現操作資源的動詞,錯誤示範:

特殊的介面可以出現動詞,因為這些介面一般沒有乙個明確的資源,或是動詞就是介面的核心含義

3.1 正常響應

3.2 重定向響應

3.3 客戶端異常

3.4 伺服器異常

4.1 響應資料要有狀態碼、狀態資訊以及資料本身

,

"address":"月羅路2380號",

"province":"上海市",

"city":"上海市",

"area":"寶山區",

"street_id":"339ed41ae1d6dc320a5cb37c",

"telephone":"(021)56761006",

"detail":1,

"uid":"339ed41ae1d6dc320a5cb37c"

}...

]}

4.2 需要url請求的資源需要訪問資源的請求鏈結

...]

}

url設計

資料的安全保障

介面特徵的表現

資料版本設計,第一代,第二代

資料介面請求資源的url設計,一般提倡複數的形式,禁止出現操作資源的動詞,特殊情況的介面可以出現動詞

請求資源的請求方式url設計,增刪改查,獲取單查群查,實現十大介面功能等

響應狀態碼

請求正常響應,200常規請求,201建立成功

重定向響應:301:永久重定向,302:暫時重定向

3. 客戶端異常:403:請求無許可權,404請求路徑不存在,405請求方法不存在

伺服器異常響應:500:伺服器異常

響應結果

響應資料要有狀態碼,狀態資訊,響應資料本身

狀態碼:status: 0成功,1:失敗

狀態資訊:msg: "ok", "error"

響應資料本身:results: "列表","字典"

restful介面規範

資源 resource 任何東西都是一種資源,例如,一篇部落格文章 表示 representation 資源的一種表現形式,例如,json xml url 每個資源都應該有乙個對應的url uri url是uri的一種,url都有對應的資源,而uri不一定,它強調的是一種資源標識 get 獲得乙個資...

restful介面規範

聯絡兩個物質的媒介,完成資訊互動 web程式中 聯絡前台頁面與後台資料庫的媒介 web介面組成 請求引數 前台按照指定的key提供資料給後台 響應資料 後台與資料庫互動後將資料反饋給前台 狀態碼,狀態資訊,響應資料 web資料請求介面設計規範共10條,可以分為url與響應兩部分 url 響應部分 f...

Restful介面規範

rest,即resources representational state transfer 資源表現層狀態轉化 資源 resources 網路上的乙個實體,每種資源對應乙個特定的uri 統一資源識別符號 表現層 representational 資源呈現的形式,比如 json 狀態轉化 stat...