RESTFUL規範建議

2022-05-17 10:44:09 字數 1273 閱讀 7177

restful概述

restful是目前最流行的一種網際網路軟體架構,是程式和程式之間進行資料互動需要遵循的規範。它結構清晰、符合標準、易於理解、擴充套件方便,所以正得到越來越多**的採用。

rest是representational state transfer的縮寫,是roy thomas fielding在他2023年的博士**中提出的。其提出的設計概念和準則為:

網路上的所有事物都可以抽象為資源

每個資源都應該有唯一的標識(identifier),對資源的操作不會改變標識

所有的操作都是無狀態的

使用標準方法(get、post、put、patch、delete)操作資源

1. https代替http,保證資料傳輸時安全。

2. 在url中一般要體現api標識,這樣看到url就知道他是乙個api。

建議,因為他不會存在跨域的問題)

假設:前段:

後端:3. 在介面中要體現版本

注意:版本還可以放在請求頭中

accept: ...

4. restful也稱為面向資源程式設計,視網路上的一切都是資源,對資源可以進行操作,所以一般資源都用名詞。

user/

5. 如果要加入一些篩選條件,可以新增在url中

user/?page=1&type=9

6. 根據method不同做不同操作。

get、post、put、patch、delete

7. 返回給使用者狀態碼

- 200,成功

- 300,301永久 /302臨時

- 400,403拒絕 /404找不到

- 500,服務端**錯誤

自定製狀態碼:

def get(self,request,*args,**kwargs):

result =

try:

val = int('你好')

except exception as e:

result['code'] = 10001

result['error'] = '資料轉換錯誤'

return response(result)

8. 返回值

空9. 操作異常時,要返回錯誤資訊

restful介面規範

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

restful規範介紹

團隊之間協作有很多的介面規範,團隊做大了,平台之間的資料傳輸的規範需要定義好。需要有乙個閥,restful 就是這樣的乙個規範,我們都應該遵守這樣的乙個規範。越來越多的人意識到,即軟體,而且是一種新型的軟體 開發,完全可以採用軟體開發的模式。但是傳統上,軟體和網路是兩個不同的領域,網際網路的興起讓這...

RESTful格式規範

restful是介面開發格式裡面很重要的乙個山頭,基本開發介面都需要遵守這個規範,它共有十條規範格式 1 網域名稱,一般將api放在組網域名稱下 3 路徑,路徑表示api的具體 代表一種資源,中不能使用動詞,只能使用名詞,而其必須是複數 4 使用標準的http方法,由http動詞組成 get sel...