DRF 1 API介面規範

2022-05-15 08:13:23 字數 1027 閱讀 4041

rest全稱是representational state transfer,中文意思是表述(編者注:通常譯為表徵性狀態轉移)。 它首次出現在2023年roy fielding的博士**中。

restful是一種定義web api介面的設計風格,尤其適用於前後端分離的應用模式中。

這種風格的理念認為後端開發任務就是提供資料的,對外提供的是資料資源的訪問介面,所以在定義介面時,客戶端訪問的url路徑就表示這種要操作的資料資源。

事實上,我們可以使用任何乙個框架都可以實現符合restful規範的api介面。

1.1 資料安全

1.2 介面特徵表現

1.3 多資料版本共存

1.4 資料即是資源,均使用名詞(可複數)

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

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

1.5 資源操作由請求方式決定(method)

1.6 過濾,通過在url上傳參的形式傳遞搜尋條件

1.7 響應狀態碼

1.7.1 正常響應

1.7.2 重定向響應

1.7.3 客戶端異常

1.7.4 伺服器異常

1.8 錯誤處理,應返回錯誤資訊,error當做key

1.9 返回結果,針對不同操作,伺服器向使用者返回的結果應該符合以下規範

get /collection:返回資源物件的列表(陣列)

get /collection/resource:返回單個資源物件

post /collection:返回新生成的資源物件

put /collection/resource:返回完整的資源物件

patch /collection/resource:返回完整的資源物件

delete /collection/resource:返回乙個空文件

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

...]}

介面規範 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代表版本號,分為整形和浮點型 整形的版本號 大功能版本發布形式 具有當前版本狀態下的...