Restful API編寫規範

2021-09-25 21:11:01 字數 956 閱讀 1930

動詞 + 賓語
restful 的核心思想就是,客戶端發出的資料操作指令都是"動詞 + 賓語"的結構。比如,get /articles這個命令,get是動詞,/articles是賓語。

動詞通常就是五種 http 方法,對應 crud 操作。

get:讀取(read)

post:新建(create)

put:更新(update)

patch:更新(update),通常是部分更新

delete:刪除(delete)

根據 http 規範,動詞一律大寫

賓語必須是名詞

correct:

error :

複數 url
既然 url 是名詞,那麼應該使用複數,還是單數?

這沒有統一的規定,但是常見的操作是讀取乙個集合,比如get /articles(讀取所有文章),這裡明顯應該是複數。

為了統一起見,建議都使用複數 url,比如get /articles/2要好於get /article/2。

狀態碼狀態碼必須精確

客戶端的每一次請求,伺服器都必須給出回應。回應包括 http 狀態碼和資料兩部分。

http 狀態碼就是乙個三位數,分成五個類別。

這五大類總共包含100多種狀態碼,覆蓋了絕大部分可能遇到的情況。每一種狀態碼都有標準的(或者約定的)解釋,客戶端只需檢視狀態碼,就可以判斷出發生了什麼情況,所以伺服器應該返回盡可能精確的狀態碼。

RESTful api介面規範

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

Restful Api介面規範

用名詞代替動詞表示資源 get employees get employees?state external post employees put employees 56 對可選的 複雜的引數,使用查詢字串 get employees?state internal maturity senior ...

RESTful api介面規範

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