Q_GZLC002-2020API接口标准规范.pdf

Q/GZLC 贵州力创科技发展有限公司企业标准 Q/GZLC002-2020 API接 口标准规范 2019-12-01发布 2020-01-01实施 贵州力创科技发展有限公司 发布 Q/GZLC002-2020 前 言 本标准的编写格式符合GB/T1.1-2000 《标准化工作导则第I部分：标准的结构和编写 规则》、GB/T1.2-2002 《标准化工作导则 第2部分：标准中规范性技术要素内容的确定方 法》的规格。本标准是根据贵州力创科技发展有限公司在大数据分析软件项目的需要，为数 据模型的规范化设计、开发、管理而制定。 本标准的试验方法采用了相应的国家标准的规 定。 本标准由贵州力创科技发展有限公司标准化委员会提出。 本标准起草单位：贵州力创科技发展有限公司提岀并起草。 本标准主要起草人：张涛、陶心万、雷厚宇、陆苇、黄纪萍、杨启帆 审核：兰海翔 批准：李卫群 本标准委托贵州力创科技发展有限公司研发部负责解释。 本标准2019年12月首次发布。 2 Q/GZLC002-2020 API接口标准规范 1、总则 1.1列入本标准体系的内容将在前后端分离的软件项目开发场景有一定的通用性，适应 贵州力创科技在前后端分离类软件项目的发展需要，并具有一定的前瞻性。 1.2本标准体系的编制应分类科学、层次清晰、结构合理，力求反应贵州力创科技在前 后端分离的软件开发项目建设的要求，并为未来的发展做好扩展性。 1.3本标准体系应充分考虑科学性、系统性、可扩延性、兼容性、实用性原则。 2、背景 随着软件开发行业前后端分离的开发模式越来越流行的背景下，贵州力创科技在软件开 发规范上进一步对软件开发工作进行接口规范定义，用于开发人员间形成开发契约减少开发 沟通成本，简化测试流程，提高故障排查能力。 《贵州力创科技API接口规范》主要围绕软件项目中前后端分离这种场景的接口整个规 划、建设、应用等几个主要方面来组成标准规范，作为今后贵州力创科技对前后端分离类的 软件项目的主要依据。 本规范标准的建立：一是用作前后端分离类软件项目的前后端数据交互的参照依据；二 是通过规范标准的实施使相关人员工作界面清晰、沟通效率提高，同时降低测试难度，提高 设计和开发效率，引导项目管理、设计和开发追求更卓越的绩效，提高企业竞争力。 3、术语和定义 3.1 API API （ApplicationProgrammingInterface）指应用程序接口。它是一些预先定义的函 数，或指软件系统不同组成部分衔接的约定。 目的是提供应用程序与开发人员基于某软件 或硬件得以访问一组例程的能力，而又无需访问原码，或理解内部工作机制的细节。 3 Q/GZLC002-2020 3.2 JSON JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式。它基于 ECMAScript 的一个子集，采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结 构使得 JSON 成为理想的数据交换语言。易于人阅读和编写，同时也易于