GAT 1293-2016 应用软件接口标准编写技术要素.pdf

ICS01.120
A90
HA
中华人民共和国公共安全行业标准
GA/T1293-2016
应用软件接口标准编写技术要素
Technical elements for standard writing of application software
interface
2016-05-11发布
2016-05-11实施
中华人民共和国公安部发布
GA/T1293~-2016
前言
本标准按照GB/T1.1-2009给出的规则起草。
本标准由公安部科技信息化局提出。
本标准由公安部计算机与信息处理标准化技术委员会归口。
本标准起草单位:公安部科技信息化局、公安部第一研究所、烟台海顾软件股份有限公司
本标准主要起草人:赵海平、李佰全、李如香、郭欣、闫建华。
GA/T1293-~2016
应用软件接口标准编写技术要素
1范围
本标准规定了应用软件接口标准编写涉及的主要技术要素。
本标准适用于成用软件接口标准的编写。
2应用软件接口编写技术要素
2.1要素组成
应用软件接口标准内容宜包括接口框架、接口定义和异常事件等技术要素
2.2接口框架
2.2.1概述
接口框架宜包括总体框架、使用要求、安全性要求和版本等技术要素。
2.2.2总体框架
应说明接口的应用环境、交互方式和主要功能等,必要时给出接口框架图和接口清单
2.2.3使用要求
应说明接口的申请、授权、调用的方法和流程等技术要求。
2.2.4安全性要求
对使用接口有安全性要求的,应给出相应的安全性保障措施的技术要求,如身份认证、访问控制和
安全审计等。
2.2.5版本
对使用接口有版本要求的,应给出版本说明及控制要求
2.3接口定义
2.3.1概述
接口定义宜包括接口名称、接口标识、接口描述、输入输出参数、返回值、性能要求和日志等技术
要素
2.3.2接口名称
应使用中文名称,反映接口业务特性,简眀扼要。
2.3.3接口标识
接口标识是接口的澡作标识符。宜使用字母、数字和下划线等按一定规则组成。
GA/T1293~-2016
2.3.4接口描述
宜具体说明该接口的接口声明、功能说明、调用方法、通信协议和注意事项等。
2.3.5输入/输出参数
应逐项进行说明,包括参数的数据类型、格式和限制性要求等。
2.3.6返回值
宜对返回值的类型、格式、含义和限制性要求等进行说明
3.7性能要求
宜说明接口响应能力、并发支持和稳定性等要求及相关指标。
2.3.8日志
宜给出接口使用日志的技术要求
2.4异常事件
应给出接口的异常事件说明,如异常事件代码、类型和响应策略等。