一种接口定义方法和数据传输方法及装置制造方法及图纸

本发明专利技术公开了一种接口定义方法和数据传输方法及装置，用以解决现有技术中定义接口的准确性和可扩展性较低的问题。该方法接口工具采用预设的接口描述语言定义接口，根据定义的接口生成接口文件，将接口文件提供给服务端，使服务端根据接口文件中包含的原始格式中各字段与目标格式中各字段的对应关系，将原始格式的数据转换为目标格式的数据。由于本申请采用预设的接口描述语言定义接口，而接口描述语言对字段的描述能力较强，可准确的描述目标格式中的各字段，因此可有效提高定义接口的准确性。另外，由于接口描述语言除了可描述基于HTTP的接口以外，还可描述基于其他协议的接口，因此也可有效提高定义接口的可扩展性。

【技术实现步骤摘要】

本申请涉及计算机
，尤其涉及一种接口定义方法和数据传输方法及装 置。
技术介绍
随着计算机技术的发展，由后端设备向前端设备提供数据、由前端设备根据该数 据为用户提供服务的模式已经非常普遍。其中，后端设备可以是服务端，前端设备可以是客 户端。 例如，客户端可先向服务端发送诸如超文本传输协议（HyperTextTransfer Protocol，HTTP)请求等请求消息，服务端接收到该请求消息后，则根据该请求消息向客户 端返回相应的数据，客户端则解析接收到的数据并展现给用户。 但是，如果客户端能够解析的数据的格式与服务端返回的数据的格式不一致，就 会导致客户端不能正确的解析服务端返回的数据，因此，这就需要预先定义客户端和服务 端之间的接口，使服务端返回的数据的格式能够被客户端正确的解析。 具体的，在现有技术中，一般使用api-blueprint工具来定义接口。由于 api-blueprint工具定义接口所使用的是markdown语言，因此，对于用户来说，使用 api-blueprint工具定义的接口具有较好的可读性。 然而，虽然markdown语言对用户具有较强的可读性，但其对具体字段的描述能力 不足，如，markdown语言不能描述一个字段中的数据是整型还是浮点型，也不能描述数据的 取值范围等，这就导致使用markdown语言定义接口的准确性较低。而且，markdown语言只 能描述基于HTTP的接口，不能对基于其他协议的接口进行描述,这也导致使用markdown语 言定义接口的可扩展性较低。
技术实现思路
本申请实施例提供一种接口定义方法和数据传输方法及装置，用以解决现有技术 中定义接口的准确性和可扩展性较低的问题。 本申请实施例提供的一种接口定义方法，包括： 接口工具采用预设的接口描述语言定义接口； 根据定义的所述接口生成接口文件，其中，所述接口文件中包含原始格式中各字 段与目标格式中各字段的对应关系； 将所述接口文件提供给服务端，使所述服务端根据所述接口文件将原始格式的数 据转换为目标格式的数据。 本申请实施例提供的一种数据传输方法，包括： 服务端接收请求消息； 根据所述请求消息确定要返回的原始格式的数据； 根据接口工具提供的接口文件中包含的原始格式中各字段与目标格式中各字段 的对应关系，将所述原始格式的数据转换为目标格式的数据； 返回转换的目标格式的数据。 本申请实施例提供的一种接口定义装置，包括： 定义模块，用于采用预设的接口描述语言定义接口； 接口文件生成模块，用于根据定义的所述接口生成接口文件，其中，所述接口文件 中包含原始格式中各字段与目标格式中各字段的对应关系； 提供模块，用于将所述接口文件提供给服务端，使所述服务端根据所述接口文件 将原始格式的数据转换为目标格式的数据。 本申请实施例提供的一种数据传输装置，包括： 接收模块，用于接收请求消息； 确定模块，用于根据所述请求消息确定要返回的原始格式的数据； 转换模块，用于根据接口工具提供的接口文件中包含的原始格式中各字段与目标 格式中各字段的对应关系，将所述原始格式的数据转换为目标格式的数据； 发送模块，用于返回转换的目标格式的数据。 本申请实施例提供一种接口定义方法和数据传输方法及装置，该方法接口工具采 用预设的接口描述语言定义接口，根据定义的接口生成接口文件，将接口文件提供给服务 端，使服务端根据接口文件中包含的原始格式中各字段与目标格式中各字段的对应关系， 将原始格式的数据转换为目标格式的数据。由于本申请采用预设的接口描述语言定义接 口，而接口描述语言对字段的描述能力较强，可准确的描述目标格式中的各字段，因此可有 效提高定义接口的准确性。另外，由于接口描述语言除了可描述基于HTTP的接口以外，还 可描述基于其他协议的接口，因此，也可有效提高定义接口的可扩展性。【附图说明】 此处所说明的附图用来提供对本申请的进一步理解，构成本申请的一部分，本申 请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中： 图1为本申请实施例提供的定义接口的过程； 图2为本申请实施例提供的数据传输的过程； 图3为本申请实施例提供的由接口工具、服务端和客户端组成的系统结构示意 图； 图4为本申请实施例提供的接口定义装置结构示意图； 图5为本申请实施例提供的数据传输装置结构示意图。【具体实施方式】 为使本申请的目的、技术方案和优点更加清楚，下面将结合本申请具体实施例及 相应的附图对本申请技术方案进行清楚、完整地描述。显然，所描述的实施例仅是本申请一 部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有做 出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。图1为本申请实施例提供的定义接口的过程，具体包括以下步骤： S101 :接口工具采用预设的接口描述语言定义接口。 在本申请实施例中，接口工具摒弃了传统的通过markdown语言定义接口的方式， 而采用预设的接口描述语言定义接口。其中，本申请所述的接口描述语言是指对字段的描 述能力较强，并且除了可以描述基于HTTP协议的接口以外，还可以描述基于其他协议接口 的语言。如，预设的接口描述语言可以是JSON-Schema语言。下面以预设的接口描述语言 为JSON-Schema语言为例进行说明。 由于JSON-Schema语言对字段具有较强的描述能力，因此，采用JSON-Schema定义 接口可有效提高定义接口的准确性。 具体的，JSON-Schema语言可描述一个字段中的数据是整型还是浮点型、数据的取 值范围等诸多的数据属性，因此，相比于markdown语言，采用JSON-Schema语言可更准确的 定义接口。 另外，由于JSON-Schema语言除了可描述基于HTTP的接口以外，还可描述其他协 议的接口，因此，采用JSON-Schema语言定义接口也可提高定义接口的可扩展性。 S102 :根据定义的接口生成接口文件，其中，接口文件中包含原始格式中各字段与 目标格式中各字段的对应关系。 在本申请实施例中，接口工具定义接口后，可根据定义的接口生成接口文件。其 中，由于接口工具是采用预设的接口描述语言定义接口的，因此，生成的接口文件也是基于 该预设的接口描述语言的。 例如，当接口工具采用JSON-Schema语言定义接口时，生成的接口文件也是基于 JSON-Schema语言的。也即，接口文件中通过JSON-Schema语言描述了目标格式中各字段的 格式，以及目标格式中当前第1页1 2 3 4 本文档来自技高网...

【技术保护点】
一种接口定义方法，其特征在于，包括：接口工具采用预设的接口描述语言定义接口；根据定义的所述接口生成接口文件，其中，所述接口文件中包含原始格式中各字段与目标格式中各字段的对应关系；将所述接口文件提供给服务端，使所述服务端根据所述接口文件将原始格式的数据转换为目标格式的数据。

【技术特征摘要】

【专利技术属性】
技术研发人员：徐凯，王跃乐，董松洁，
申请(专利权)人：阿里巴巴集团控股有限公司，
类型：发明
国别省市：开曼群岛;KY