2024工業(yè)互聯(lián)網(wǎng)平臺(tái)接口開發(fā)規(guī)范

工業(yè)互聯(lián)網(wǎng)平臺(tái)接口開發(fā)規(guī)范工業(yè)互聯(lián)網(wǎng)平臺(tái)接口開發(fā)規(guī)范目錄第一章概述 31.1.介紹 31.2.編寫目的 31.3.編寫原則 31.4.變更歷史 5第二章接口開發(fā)過程 5第三章接口規(guī)范 53.1.接口地址命名規(guī)范 53.2.微服務(wù)組件服務(wù)命名規(guī)范 63.3.目錄第一章概述 31.1.介紹 31.2.編寫目的 31.3.編寫原則 31.4.變更歷史 5第二章接口開發(fā)過程 5第三章接口規(guī)范 53.1.接口地址命名規(guī)范 53.2.微服務(wù)組件服務(wù)命名規(guī)范 63.3.接口調(diào)用規(guī)范 73.4.CRUD資源規(guī)范 73.4.1.添加資源 73.4.2.刪除資源 73.4.3.更新資源 83.4.4.獲取列表 83.4.5.獲取詳情 93.4.6.搜索條件 102第一章概述1.1.介紹RESTwebURLRESTfulWebHTTP來表示不同的操作的調(diào)用。RESTCRUDHTTPPOST-創(chuàng)建資源第一章概述1.1.介紹RESTwebURLRESTfulWebHTTP來表示不同的操作的調(diào)用。RESTCRUDHTTPPOST-創(chuàng)建資源GET-檢索資源PUT–更新資源DELETE-刪除資源RESTJavanetPHP們都依賴基本HTTP協(xié)議。1.2.編寫目的編寫本文的目的是為了將系統(tǒng)功能進(jìn)行模塊化、服務(wù)化，將用戶的操作以服務(wù)的方式提供。系統(tǒng)與系統(tǒng)之間遵循服務(wù)規(guī)范，將系統(tǒng)與系統(tǒng)之間的交互轉(zhuǎn)為定制化服務(wù)交互，以實(shí)現(xiàn)系統(tǒng)與系統(tǒng)之間的集成。1.3.編寫原則3（Addressability）RESTOOP必須可以通過URI尋址或訪問。接口一致性（Interfaceuniformity）SOAPRESTfulHTTP支持的方法，比如GET、PUT（Addressability）RESTOOP必須可以通過URI尋址或訪問。接口一致性（Interfaceuniformity）SOAPRESTfulHTTP支持的方法，比如GET、PUTPOSTDELETEWSDL儲(chǔ)客戶機(jī)的狀態(tài)信息。這使服務(wù)器不與特定的客戶機(jī)相綁定，負(fù)載平衡變得簡(jiǎn)單多了。這還讓服務(wù)器更容易監(jiān)視、更可靠。具象（Representational）客戶機(jī)總是與資源的某種具象交互，絕不會(huì)直接與資源本身交互。同一資源還可以有多個(gè)具象。理論上說，持有資源的具象的任何客戶機(jī)應(yīng)該有操縱底層資源的足夠信息。連通性（Connectedness）任何基于REST的系統(tǒng)都應(yīng)該預(yù)見到客戶機(jī)需要訪問相關(guān)的資源，應(yīng)該在返回的資源具象中包含這些資源。例如，可以以超鏈接的形式包含特定RESTful服務(wù)的操作序列中的相關(guān)步驟，讓客戶機(jī)可以根據(jù)需要訪問它們。41.4.變更歷史第二章接口開發(fā)過程審核人：質(zhì)量管控：第三章接口規(guī)范命名約定：全小寫的英文加數(shù)字禁止內(nèi)容：未經(jīng)允許，請(qǐng)勿英文和漢語拼音，以及大小寫混合命名1.5.接口地址命名規(guī)范5類別組件名稱接口地址app目標(biāo)管理Appapp/target/**無人值守Appapp/ugs/**序號(hào)變更人員變更時(shí)間變更內(nèi)容1.4.變更歷史第二章接口開發(fā)過程審核人：質(zhì)量管控：第三章接口規(guī)范命名約定：全小寫的英文加數(shù)字禁止內(nèi)容：未經(jīng)允許，請(qǐng)勿英文和漢語拼音，以及大小寫混合命名1.5.接口地址命名規(guī)范5類別組件名稱接口地址app目標(biāo)管理Appapp/target/**無人值守Appapp/ugs/**序號(hào)變更人員變更時(shí)間變更內(nèi)容token接口，接口地址為：sys/auth/gettoken。遠(yuǎn)程調(diào)用完整地址為：域名+端口號(hào)+接口地址。1.6.微服務(wù)組件服務(wù)命名規(guī)范app“target-management-app”。6設(shè)備運(yùn)維Appapp/pms/**車間設(shè)備聯(lián)網(wǎng)Appapp/tpm/**環(huán)境監(jiān)測(cè)Appapp/emis/**hr人資管理基礎(chǔ)服務(wù)hr/**iot物聯(lián)云基礎(chǔ)服務(wù)iot/**mes制造云基礎(chǔ)服務(wù)mes/**crm營(yíng)銷云基礎(chǔ)服務(wù)crm/**pdm設(shè)計(jì)管理pdm/**mms物料管理mms/**qms質(zhì)量管理qms/**bi商業(yè)智能bi/**erp財(cái)務(wù)管理erp/**activity工作流服務(wù)activity/**sys平臺(tái)基礎(chǔ)服務(wù)sys/**統(tǒng)一認(rèn)證服務(wù)sys/auth/**用戶管理sys/user/**部門管理token接口，接口地址為：sys/auth/gettoken。遠(yuǎn)程調(diào)用完整地址為：域名+端口號(hào)+接口地址。1.6.微服務(wù)組件服務(wù)命名規(guī)范app“target-management-app”。6設(shè)備運(yùn)維Appapp/pms/**車間設(shè)備聯(lián)網(wǎng)Appapp/tpm/**環(huán)境監(jiān)測(cè)Appapp/emis/**hr人資管理基礎(chǔ)服務(wù)hr/**iot物聯(lián)云基礎(chǔ)服務(wù)iot/**mes制造云基礎(chǔ)服務(wù)mes/**crm營(yíng)銷云基礎(chǔ)服務(wù)crm/**pdm設(shè)計(jì)管理pdm/**mms物料管理mms/**qms質(zhì)量管理qms/**bi商業(yè)智能bi/**erp財(cái)務(wù)管理erp/**activity工作流服務(wù)activity/**sys平臺(tái)基礎(chǔ)服務(wù)sys/**統(tǒng)一認(rèn)證服務(wù)sys/auth/**用戶管理sys/user/**部門管理sysDepart/**字典管理sys/dict/**1.7.接口調(diào)用規(guī)范httpfeignheaderX_ACCESS_TOKEN（token）”和“Account-Set-Id（id）"。feignjeecg-boot-starter-cloud模 塊 下 的FeignConfig類 中 的requestInterceptorhttp遠(yuǎn)程調(diào)用方式可采用httpClient,同樣需要在請(qǐng)求header中加入“X_ACCESS_TOKEN（token）”和“Account-Set-Id（id）"。1.8.CRUD1.8.1.添加資源1.7.接口調(diào)用規(guī)范httpfeignheaderX_ACCESS_TOKEN（token）”和“Account-Set-Id（id）"。feignjeecg-boot-starter-cloud模 塊 下 的FeignConfig類 中 的requestInterceptorhttp遠(yuǎn)程調(diào)用方式可采用httpClient,同樣需要在請(qǐng)求header中加入“X_ACCESS_TOKEN（token）”和“Account-Set-Id（id）"。1.8.CRUD1.8.1.添加資源1.8.2.刪除資源7請(qǐng)求方式DELETE請(qǐng)求方式POST服務(wù)路徑/api/XXX/參數(shù)類型application/json參數(shù)描述{“key”:”value”}備注：key：鍵，value:值返回值類型application/json描述{code:200,msg:"success",data:{}}1.8.3.更新資源1.8.4.獲取列表8請(qǐng)求方式GET請(qǐng)求方式PUT服務(wù)路徑/api/XXX/{id}參數(shù)類型application/json參數(shù)描述{“key”:”value”}備注：key：鍵，value:值返回值類型application/json描述{code:200,msg:"success",data:{}}服務(wù)路徑/api/XXX/{id}參數(shù)類型無參數(shù)描述無返回值類型application/json描述{code:200,1.8.3.更新資源1.8.4.獲取列表8請(qǐng)求方式GET請(qǐng)求方式PUT服務(wù)路徑/api/XXX/{id}參數(shù)類型application/json參數(shù)描述{“key”:”value”}備注：key：鍵，value:值返回值類型application/json描述{code:200,msg:"success",data:{}}服務(wù)路徑/api/XXX/{id}參數(shù)類型無參數(shù)描述無返回值類型application/json描述{code:200,msg:"success",data:{}}1.8.5.獲取詳情9請(qǐng)求方式GET服務(wù)路徑/api/XXX/{id}參數(shù)類型無參數(shù)描述無返回值類型application/json描述{code:200,msg:"success",data:{}}服務(wù)路徑/api/XXX/參數(shù)類型無參數(shù)描述無返回值類型application/json描述{code:200,1.8.5.獲取詳情9請(qǐng)求方式GET服務(wù)路徑/api/XXX/{id}參數(shù)類型無參數(shù)描述無返回值類型application/json描述{code:200,msg:"success",data:{}}服務(wù)路徑/api/XXX/參數(shù)類型無參數(shù)描述無返回值類型application/json描述{code:200,msg:"success",data:{list:[],pagination:{currentPage:1,pageSize:20,total:2000}}}1.8.6.搜索條件10分頁列表通用搜索條件{keyword:'',//關(guān)鍵字，默認(rèn)為空sort:'', //排序方式(dsc,asc),默認(rèn)1.8.6.搜索條件10分頁列表通用搜索條件{keyword:'',//關(guān)鍵字，默認(rèn)為空sort:'', //排序方式(dsc,asc),默認(rèn)sidx:'', //排序字段currentPage: