路径: 主页 > MISC > 第78页 > GA/T 1293-2016 | 标准编号 | GA/T 1293-2016 (GA/T1293-2016) | | 中文名称 | 应用软件接口标准编写技术要素 | | 英文名称 | Technical elements for standard writing of application software interface | | 行业 | 公安行业标准 (推荐) | | 中标分类 | A90 | | 字数估计 | 5,560 | | 发布日期 | 2016-05-11 | | 实施日期 | 2016-05-11 | | 发布机构 | 公安部 | GA/T 1293-2016
(Application of software interface standard to write technical)
ICS 01.120
A90
中华人民共和国公共安全行业标准
应用软件接口标准编写技术要素
interface
2016-05-11发布
2016-05-11实施
中华人民共和国公安部 发 布
前言
本标准按照 GB/T 1.1-2009给出的规则起草。
本标准由公安部科技信息化局提出。
本标准由公安部计算机与信息处理标准化技术委员会归口。
本标准起草单位:公安部科技信息化局、公安部第一研究所、烟台海颐软件股份有限公司。
本标准主要起草人:赵海平、李佰全、李如香、郭欣、闫建华。
应用软件接口标准编写技术要素
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 接口标识
接口标识是接口的操作标识符。宜使用字母、数字和下划线等按一定规则组成。
......
|