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

ICS 01.120GAA 90中华人民共和国公共安全行业标准GA/T 1293—2016应用软件接口标准编写技术要素Technical elements for standard writing of application softwareinterface2016-05-11 发布2016-05-11 实施中华人民共和国公安部发布 GA/T 1293—2016前言本标准按照GB/T1.1一2009给出的规则起草。本标准由公安部科技信息化局提出。本标准由公安部计算机与信息处理标准化技术委员会归口。本标准起草单位：公安部科技信息化局、公安部第一研究所、烟台海颐软件股份有限公司。本标准主要起草人：赵海平、李佰全、李如香、郭欣、闫建华。I GA/T 1293--2016应用软件接口标准编写技术要素1范围本标准规定了应用软件接口标准编写涉及的主要技术要素。本标准适用于应用软件接口标推的编写。2应用软件接口编写技术要素2.1 要素组成2.2接口框架2.2.1概述接口框架宜包括总体框架、使用要求、安全性要求和版本等技术要素。2.2.2总体框架应说明接口的应用环境、交互方式和主要功能等，必要时给出接口框架图和接口清单。3使用要求2.2.3应说明接口的申请、授权、调用的方法和流程等技术要求。2.2.4安全性要求对使用接口有安全性要求的，应给出相应的安全性保障措施的技术要求，如身份认证、访问控制和安全审计等。2.2.5版本对使用接口有版本要求的，应给出版本说明及控制要求。2.3接口定义2.3.1概述接口定义宜包括接口名称、接口标识、接口描述、输人输出参数、返回值、性能要求和日志等技术要素。2.3.2接口名称应使用中文名称，反映接口业务特性，简明扼要。2.3.3接口标识接口标识是接口的操作标识符。宜使用字母、数字和下划线等按一定规则组成。1 GA/T 1293—20162.3.44接口描述宜具体说明该接口的接口声明、功能说明、调用方法、通信协议和注意事项等。2.3.55输入/输出参数应逐项进行说明，包括参数的数据类型、格式和限制性要求等。2.3.6返回值宜对返回值的类型、格式、含义和限制性要求等进行说明。2.3.7性能要求宜说明接口响应能力、并发支持和稳定性等要求及相关指标。2.3.8日志宜给出接口使用日志的技术要求。2.4异常事件应给出接口的异常事件说明，如异常事件代码、类型和响应策略等。2 中华人民共和国公共安全行业标准应用软件接口标准编写技术要素GA/T 1293—2016中国标准出版社出版发行北京市朝阳区和平里西街甲2号（100029)北京市西城区三里河北街16号（100045)网址 总编室：（010行中心：（010者服务部：（010国标准出版社秦皇岛印刷厂印刷各地新华书店经销*开本880×12301/16印张 0.5字数 ６千字2016年8月第一版　2016年8月第一次印刷*书号：155066·2-30326如有印装差错由本社发行中心调换版权专有侵权必究举报电话：（010A/T 1293-20t6