軟件工程過(guò)程資料模板-接口設(shè)計(jì)說(shuō)明書(shū)-資料下載頁(yè)
2025-08-04 05:21本頁(yè)面
【正文】 WebService接口相關(guān)的技術(shù)，如簡(jiǎn)介認(rèn)證、壓縮、數(shù)據(jù)規(guī)約及需要描述的一些規(guī)定等，根據(jù)需要增加下級(jí)目錄說(shuō)明，下述目錄為建議性質(zhì). WebService概述本節(jié)可根據(jù)需要增刪。Comment [xsw2]: 表格合并Comment [xsw3]: 表格合并Comment [xsw4]: 增加項(xiàng)目名稱 接口設(shè)計(jì)說(shuō)明書(shū)杭州朗新信息科技有限公司 版權(quán)所有 2022 5本節(jié)可根據(jù)需要增刪。說(shuō)明認(rèn)證機(jī)制說(shuō)明格式約定、DTD 等 1如提供給銀行的“查詢電費(fèi)”功能，一些需要說(shuō)明的信息在此說(shuō)明。如果功能比較復(fù)雜，可以根據(jù)需要設(shè)立下級(jí)子功能的目錄結(jié)構(gòu)。Webservice 服務(wù)的使用表格描述。 1如果功能簡(jiǎn)單，此級(jí)目錄可以不要，使用 Webservice服務(wù)表格描述。Webservice接口服務(wù)表格如下:方法名稱 說(shuō)明服務(wù)的 CODE和名稱描述發(fā)布路徑參數(shù)代碼 參數(shù)名稱 數(shù)據(jù)類型 參數(shù)說(shuō)明輸入?yún)?shù)參數(shù)代碼 參數(shù)名稱 數(shù)據(jù)類型 參數(shù)說(shuō)明輸出參數(shù)錯(cuò)誤信息部署情況示例 使用開(kāi)發(fā)代碼舉例說(shuō)明如何調(diào)用項(xiàng)目名稱 接口設(shè)計(jì)說(shuō)明書(shū)6 杭州朗新信息科技有限公司 版權(quán)所有 20227 文件接口 文件名稱說(shuō)明傳輸文件的名稱規(guī)則及格式，如 文件格式定義根據(jù)需要，說(shuō)明文件的列分割，行分割等條件，建議用表格方式。例如字段可以使用下列表格。序號(hào) 字段中文名 字段英文名 字段類型 字段含義1 抄表接口數(shù)據(jù)標(biāo)識(shí) DATA_ID NUMBER(15)本實(shí)體記錄的唯一標(biāo)識(shí)，產(chǎn)生規(guī)則為流水號(hào)。下裝時(shí)填寫(xiě)2 申請(qǐng)編號(hào) APP_NO VARCHAR2(16)流程實(shí)例的唯一標(biāo)識(shí)，可自行編碼。下裝時(shí)填寫(xiě) 傳輸方法說(shuō)明定期傳遞， FTP 或者指定目錄等，如果使用方法，則參照類似格式：功能說(shuō)明 向抄表機(jī)中傳輸文件調(diào)用位置 例如 DLL/OCX 等文件的路徑名稱等,如 函數(shù)方法 Public String qryOwe(String szStringRequest) throws RemoteException, Uexception, Exception。參數(shù)代碼/名稱 數(shù)據(jù)類型 參數(shù)說(shuō)明PORT char 通訊端口號(hào)，參見(jiàn)標(biāo)準(zhǔn)代碼PORT_NOBAUDRATEchar 通訊波特率，參見(jiàn)標(biāo)準(zhǔn)代碼BAUD_RATE輸入?yún)?shù)參數(shù)代碼/名稱 數(shù)據(jù)類型 參數(shù)說(shuō)明輸出參數(shù)示例 int SendFileToHc(char PORT,char BAUDRATE,char DATAFILE, char APPFILE, char PROMPT)。SendFileToHc(‘1’, ‘05’,’C:\。 ’, ‘C:\。 ’,’1’)。注：參數(shù) 1：’1’表述端口號(hào)為 COM1，見(jiàn)標(biāo)準(zhǔn)代碼 PORT_NO參數(shù) 2：’05’表示波特率為 ，見(jiàn)標(biāo)準(zhǔn)代碼 BAUD_RATEComment [xsw5]: 增加項(xiàng)目名稱 接口設(shè)計(jì)說(shuō)明書(shū)杭州朗新信息科技有限公司 版權(quán)所有 2022 7參數(shù) 3： 的路徑同 。參數(shù) 4： 的路徑同 。{其他約定}標(biāo)題名稱自定，例如可以約定目錄結(jié)構(gòu)、某某協(xié)議內(nèi)容等，自行擴(kuò)展。8 標(biāo)準(zhǔn)代碼約定的標(biāo)準(zhǔn)參數(shù)代碼、返回代碼等，自行擴(kuò)展。
規(guī)章制度相關(guān)推薦
鄂ICP備17016276號(hào)-1