




版權(quán)說(shuō)明:本文檔由用戶(hù)提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)
文檔簡(jiǎn)介
工業(yè)互聯(lián)網(wǎng)平臺(tái)接口開(kāi)發(fā)規(guī)范工業(yè)互聯(lián)網(wǎng)平臺(tái)接口開(kāi)發(fā)規(guī)范目錄第一章概述 31.1.介紹 31.2.編寫(xiě)目的 31.3.編寫(xiě)原則 31.4.變更歷史 5第二章接口開(kāi)發(fā)過(guò)程 5第三章接口規(guī)范 53.1.接口地址命名規(guī)范 53.2.微服務(wù)組件服務(wù)命名規(guī)范 63.3.目錄第一章概述 31.1.介紹 31.2.編寫(xiě)目的 31.3.編寫(xiě)原則 31.4.變更歷史 5第二章接口開(kāi)發(fā)過(guò)程 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來(lái)表示不同的操作的調(diào)用。RESTCRUDHTTPPOST-創(chuàng)建資源第一章概述1.1.介紹RESTwebURLRESTfulWebHTTP來(lái)表示不同的操作的調(diào)用。RESTCRUDHTTPPOST-創(chuàng)建資源GET-檢索資源PUT–更新資源DELETE-刪除資源RESTJavanetPHP們都依賴(lài)基本HTTP協(xié)議。1.2.編寫(xiě)目的編寫(xiě)本文的目的是為了將系統(tǒng)功能進(jìn)行模塊化、服務(wù)化,將用戶(hù)的操作以服務(wù)的方式提供。系統(tǒng)與系統(tǒng)之間遵循服務(wù)規(guī)范,將系統(tǒng)與系統(tǒng)之間的交互轉(zhuǎn)為定制化服務(wù)交互,以實(shí)現(xiàn)系統(tǒng)與系統(tǒng)之間的集成。1.3.編寫(xiě)原則3(Addressability)RESTOOP必須可以通過(guò)URI尋址或訪問(wèn)。接口一致性(Interfaceuniformity)SOAPRESTfulHTTP支持的方法,比如GET、PUT(Addressability)RESTOOP必須可以通過(guò)URI尋址或訪問(wèn)。接口一致性(Interfaceuniformity)SOAPRESTfulHTTP支持的方法,比如GET、PUTPOSTDELETEWSDL儲(chǔ)客戶(hù)機(jī)的狀態(tài)信息。這使服務(wù)器不與特定的客戶(hù)機(jī)相綁定,負(fù)載平衡變得簡(jiǎn)單多了。這還讓服務(wù)器更容易監(jiān)視、更可靠。具象(Representational)客戶(hù)機(jī)總是與資源的某種具象交互,絕不會(huì)直接與資源本身交互。同一資源還可以有多個(gè)具象。理論上說(shuō),持有資源的具象的任何客戶(hù)機(jī)應(yīng)該有操縱底層資源的足夠信息。連通性(Connectedness)任何基于REST的系統(tǒng)都應(yīng)該預(yù)見(jiàn)到客戶(hù)機(jī)需要訪問(wèn)相關(guān)的資源,應(yīng)該在返回的資源具象中包含這些資源。例如,可以以超鏈接的形式包含特定RESTful服務(wù)的操作序列中的相關(guān)步驟,讓客戶(hù)機(jī)可以根據(jù)需要訪問(wèn)它們。41.4.變更歷史第二章接口開(kāi)發(fā)過(guò)程審核人:質(zhì)量管控:第三章接口規(guī)范命名約定:全小寫(xiě)的英文加數(shù)字禁止內(nèi)容:未經(jīng)允許,請(qǐng)勿英文和漢語(yǔ)拼音,以及大小寫(xiě)混合命名1.5.接口地址命名規(guī)范5類(lèi)別組件名稱(chēng)接口地址app目標(biāo)管理Appapp/target/**無(wú)人值守Appapp/ugs/**序號(hào)變更人員變更時(shí)間變更內(nèi)容1.4.變更歷史第二章接口開(kāi)發(fā)過(guò)程審核人:質(zhì)量管控:第三章接口規(guī)范命名約定:全小寫(xiě)的英文加數(shù)字禁止內(nèi)容:未經(jīng)允許,請(qǐng)勿英文和漢語(yǔ)拼音,以及大小寫(xiě)混合命名1.5.接口地址命名規(guī)范5類(lèi)別組件名稱(chēng)接口地址app目標(biāo)管理Appapp/target/**無(wú)人值守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/**車(chē)間設(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)銷(xiāo)云基礎(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/**用戶(hù)管理sys/user/**部門(mén)管理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/**車(chē)間設(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)銷(xiāo)云基礎(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/**用戶(hù)管理sys/user/**部門(mén)管理sysDepart/**字典管理sys/dict/**1.7.接口調(diào)用規(guī)范httpfeignheaderX_ACCESS_TOKEN(token)”和“Account-Set-Id(id)"。feignjeecg-boot-starter-cloud模 塊 下 的FeignConfig類(lèi) 中 的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類(lèi) 中 的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ù)類(lèi)型application/json參數(shù)描述{“key”:”value”}備注:key:鍵,value:值返回值類(lèi)型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ù)類(lèi)型application/json參數(shù)描述{“key”:”value”}備注:key:鍵,value:值返回值類(lèi)型application/json描述{code:200,msg:"success",data:{}}服務(wù)路徑/api/XXX/{id}參數(shù)類(lèi)型無(wú)參數(shù)描述無(wú)返回值類(lèi)型application/json描述{code:200,1.8.3.更新資源1.8.4.獲取列表8請(qǐng)求方式GET請(qǐng)求方式PUT服務(wù)路徑/api/XXX/{id}參數(shù)類(lèi)型application/json參數(shù)描述{“key”:”value”}備注:key:鍵,value:值返回值類(lèi)型application/json描述{code:200,msg:"success",data:{}}服務(wù)路徑/api/XXX/{id}參數(shù)類(lèi)型無(wú)參數(shù)描述無(wú)返回值類(lèi)型application/json描述{code:200,msg:"success",data:{}}1.8.5.獲取詳情9請(qǐng)求方式GET服務(wù)路徑/api/XXX/{id}參數(shù)類(lèi)型無(wú)參數(shù)描述無(wú)返回值類(lèi)型application/json描述{code:200,msg:"success",data:{}}服務(wù)路徑/api/XXX/參數(shù)類(lèi)型無(wú)參數(shù)描述無(wú)返回值類(lèi)型application/json描述{code:200,1.8.5.獲取詳情9請(qǐng)求方式GET服務(wù)路徑/api/XXX/{id}參數(shù)類(lèi)型無(wú)參數(shù)描述無(wú)返回值類(lèi)型application/json描述{code:200,msg:"success",data:{}}服務(wù)路徑/api/XXX/參數(shù)類(lèi)型無(wú)參數(shù)描述無(wú)返回值類(lèi)型application/json描述{code:200,msg:"success",data:{list:[],pagination:{currentPage:1,pageSize:20,total:2000}}}1.8.6.搜索條件10分頁(yè)列表通用搜索條件{keyword:'',//關(guān)鍵字,默認(rèn)為空sort:'', //排序方式(dsc,asc),默認(rèn)1.8.6.搜索條件10分頁(yè)列表通用搜索條件{keyword:'',//關(guān)鍵字,默認(rèn)為空sort:'', //排序方式(dsc,asc),默認(rèn)sidx:'', //排序字段currentPage:
溫馨提示
- 1. 本站所有資源如無(wú)特殊說(shuō)明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶(hù)所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁(yè)內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒(méi)有圖紙預(yù)覽就沒(méi)有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫(kù)網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶(hù)上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶(hù)上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶(hù)因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。
最新文檔
- “節(jié)約糧食,拒絕浪費(fèi)”主題班會(huì)教學(xué)設(shè)計(jì)
- 人教版 (2019)全一冊(cè)第二節(jié) 籃球教案設(shè)計(jì)
- 小學(xué)基礎(chǔ)知識(shí)課件
- 養(yǎng)老金融服務(wù)全面升級(jí)方案
- 社聯(lián)文藝部社團(tuán)培訓(xùn)計(jì)劃
- 近七年廣東中考化學(xué)真題及答案2024
- 分布式光伏發(fā)電項(xiàng)目設(shè)計(jì)方案分析
- 六西格瑪管理培訓(xùn)
- 人力資源規(guī)劃管理
- 教師高曉成60課件
- (附答案)2024公需課《百縣千鎮(zhèn)萬(wàn)村高質(zhì)量發(fā)展工程與城鄉(xiāng)區(qū)域協(xié)調(diào)發(fā)展》試題廣東公需科
- 微創(chuàng)冠脈搭橋手術(shù)
- 檔案館檔案數(shù)字化加工項(xiàng)目技術(shù)方案
- 福建省泉州市2022-2023學(xué)年八年級(jí)下學(xué)期英語(yǔ)期中試卷(含答案)
- 2024版國(guó)開(kāi)電大本科《公共政策概論》在線形考(形考任務(wù)1至4)試題及答案
- 園林植物器官的識(shí)別-園林植物營(yíng)養(yǎng)器官的識(shí)別
- 宮頸癌科普講座課件
- 亞朵服務(wù)流程
- 第三十一屆YMO青少年數(shù)學(xué)思維研學(xué)交流活動(dòng)一年級(jí)復(fù)選試卷(含答案)
- 數(shù)據(jù)安全與保護(hù):確保企業(yè)數(shù)據(jù)安全與合規(guī)性
- 企業(yè)質(zhì)量管理體系的建設(shè)
評(píng)論
0/150
提交評(píng)論