接口設(shè)計(jì)模板

1、系統(tǒng)名稱(chēng)接口設(shè)計(jì)說(shuō)明書(shū)文檔編號(hào)：項(xiàng)目編號(hào)-*-5xx當(dāng)前版本：Vx.y作者：完成日期：YYYY-MM-DD密級(jí)：秘密保密范圍：由項(xiàng)目經(jīng)理指定使用范圍審批人：通過(guò)日期：*科技有限公司修改歷史版本號(hào)修改人修改日期修改內(nèi)容審批人目錄1 概述12 子系統(tǒng)說(shuō)明1 12.1 接口名 N0.1 12.2 接口名 N0.2 11概述概述說(shuō)明本文檔的描述的內(nèi)容、目的、使用場(chǎng)合等。2子系統(tǒng)說(shuō)明12.1 接口名 N0.1示例如下：接口功能：驗(yàn)證用戶(hù)是否合法。除部分特別說(shuō)明不需要用戶(hù)驗(yàn)證的接口外，此接口必須首先調(diào)用，否則會(huì)出現(xiàn)“未授權(quán)” 的異常錯(cuò)誤。在驗(yàn)證成功之后才能成功調(diào)用其它接口，該接口驗(yàn)證通過(guò)的用戶(hù)信息將保存到

2、 IHDUserSession類(lèi)的實(shí)例中，作為其它接口調(diào)用的用戶(hù)信息。此接口在內(nèi)部需要通過(guò)以下幾點(diǎn)的驗(yàn)證：1. CA驗(yàn)證，驗(yàn)證USBKey是否合法（只有系統(tǒng)策略中設(shè)置了需要 CA驗(yàn)證選項(xiàng)后才 會(huì)進(jìn)行CA的驗(yàn)證）；2. 域用戶(hù)驗(yàn)證，驗(yàn)證登錄用戶(hù)名和密碼是否是域用戶(hù)，通過(guò)Windows集成身份驗(yàn)證實(shí)現(xiàn)；3. 用戶(hù)數(shù)據(jù)庫(kù)合法性驗(yàn)證，驗(yàn)證登錄用戶(hù)是否存在于 USERS表中；4. 計(jì)算機(jī)合法性驗(yàn)證，驗(yàn)證登錄計(jì)算機(jī)是否存在于COMPUTER表中，計(jì)算機(jī)的驗(yàn)證 通過(guò)計(jì)算機(jī)名，硬盤(pán)序列號(hào)，網(wǎng)卡物理地址，IP地址這四項(xiàng)的組合進(jìn)行驗(yàn)證，具 體組合可以系統(tǒng)策略中配置；5. 如果驗(yàn)證未通過(guò)，返回false，并在客戶(hù)端日志中記錄登錄失敗的原因接口聲明：*相關(guān)數(shù)據(jù)表：輸入?yún)?shù)：*輸出參數(shù)：返回值及異常：參見(jiàn)錯(cuò)誤！未找到引用源。錯(cuò)誤！未找到引用源。返回值不變。捕獲到異常，請(qǐng)對(duì)異常進(jìn)行分析。如果異常類(lèi)型是*。2.2 接口名 N