接口设计模板
![接口设计模板](https://img.360docs.net/img99/1hxjnhp9f9wq5s8jarrrdcmxkjpnje9e-91.webp)
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
<系统名称 >接口设计说明书
文档编号:项目编号 -**-5xx当前版本:Vx.y
作者:完成日期:YYYY-MM-DD
密级:秘密保密范围:由项目经理指定使用范围审批人:通过日期:
****科技有限公司
修改历史
版本号修改人修改日期修改内容审批人
目录
1概述 (1)
2子系统说明 1 (1)
2.1接口名 NO.1 (1)
2.2接口名 NO.2 (1)
1概述
[ 概述说明本文档的描述的内容、目的、使用场合等。]
2子系统说明 1
2.1 接口名 NO.1
示例如下:
接口功能:
验证用户是否合法。
除部分特别说明不需要用户验证的接口外,此接口必须首先调用,否则会出现“未授权”的异常错误。在验证成功之后才能成功调用其它接口,该接口验证通过的用户信息将保存到IHDUserSession 类的实例中,作为其它接口调用的用户信息。
此接口在内部需要通过以下几点的验证:
1. CA 验证,验证 USBKey 是否合法(只有系统策略中设置了需要CA 验证选项后才
会进行 CA 的验证);
2.域用户验证,验证登录用户名和密码是否是域用户,通过 Windows 集成身份验证实
现;
3.用户数据库合法性验证,验证登录用户是否存在于 USERS 表中;
4.计算机合法性验证,验证登录计算机是否存在于 COMPUTER 表中,计算机的验证
通过计算机名,硬盘序列号,网卡物理地址, IP 地址这四项的组合进行验证,具体
组合可以系统策略中配置;
5.如果验证未通过,返回 false,并在客户端日志中记录登录失败的原因
接口声明:
***
相关数据表:
****
输入参数:
****
输出参数:
***
返回值及异常:
参见错误!未找到引用源。错误!未找到引用源。
返回值不变。
捕获到异常,请对异常进行分析。如果异常类型是*** 。
2.2 接口名 NO.2
接口功能:
接口声明:
相关数据表:输入参数:
输出参数:
返回值及异常: