玻璃缺陷智能檢測系統(tǒng)rest架構(gòu)協(xié)議模型、關(guān)鍵消息交互流程示例

1、T/KCH－xx4－202119附錄 附錄 A(規(guī)范性附錄)REST 架構(gòu)協(xié)議模型A.1 REST 概述 概述REST 是一種通過采用統(tǒng)一方式將所有信息抽象為資源來創(chuàng)建服務(wù)的方法，任何能夠被命名的信息都能夠作為一個資源。REST 使用一個資源標識符(URL)來標識組件之間交互所涉及的待定資源。REST 組件通過以下方式在一個資源上執(zhí)行動作：使用一個資源表述來捕獲資源的當前或預(yù)期的狀態(tài)、在組件之間傳遞該表述， 一個表述是一個字節(jié)序列， 以

2、及描述這些字節(jié)序列的表述元數(shù)據(jù)。A.2 REST 和 HTTP 方法 方法REST 服務(wù)通過 HTTP 的方法動詞來實現(xiàn)，見表 A.l。表 A.1 HTTP 方法動詞表HTTP 方法 方法 操作(CRUD 操作)POST 創(chuàng)建資源(Create)GET 讀取資源(Retrieve)PUT 更新資源(Update)DELETE 刪除資源(Delete)GET 調(diào)用不能改變系統(tǒng)狀態(tài)， 這表示該調(diào)用只返何數(shù)據(jù)給請求者而不會產(chǎn)生任何副作用。PO

3、ST 只能用于添加原先不存在的資源的場合。PUT 一般用于更新已經(jīng)存在安源的場合， 但如果指定的資源不存在， 也可以創(chuàng)建該資源。A.3 資源 資源訪問形式 訪問形式HTTP URL 格式的一般形式為：(Protocol)：//(Hostname)：(?Pl=vl&p2=v2...&pn=vn).其中，Protocol 支持 HTTP，宜支持 HTTPS；Hostname 指應(yīng)用系快中 IP 設(shè)備的主機名稱 IP地址或域名

4、；Port 指端口號；URI 指資源 URI；(?Pl=vl&p2=v2...&pn=vn)指查詢字符串，每個資源都會定義需要的或可選的查詢字符串參教，查詢字符中參數(shù)以名字/值附形式出現(xiàn)。A.4 REST 和 HTTP 響應(yīng) 響應(yīng)狀態(tài) 狀態(tài)碼REST 和 HTTP 響應(yīng)狀態(tài)碼見表 A.2。表 A.2 REST 和 HTTP 響應(yīng)狀態(tài)碼表狀態(tài)碼 狀態(tài)碼 REST 含義 含義 POST GET PUT DEL200“OK“(

5、成功)-請求已經(jīng)成功；頭部(Header)說明，無；消息體(Body)說明；在消息體中返回所請求的資源× ×T/KCH－xx4－202121405“Method Not Allowed“(方法不允許)-請求所采用的HTTP 方法對該資源不支持， 因為{API 協(xié)議}規(guī)范不允許該方法。如果設(shè)備不支持該功能，但是有效的{API協(xié)議}操作，則應(yīng)返回 403 響應(yīng)碼；頭部(Header)說明：Allow 頭部字段列出針對該資

6、源所支持的 HTTP 方法；消息體(Body)說明：無× × × ×409“Conflict“(沖突)-所執(zhí)行的操作與內(nèi)部狀態(tài)或正在執(zhí)行的過程沖突。這是一種過渡狀態(tài)，延后一定時間可以重試該操作；頭部(Header)說明：無；消息體(Body)說明：無× × ×500“Internal Server Error“(內(nèi)部服務(wù)器錯誤)-發(fā)生了內(nèi)部服務(wù)器錯誤；頭部(Heade