[发明专利]一种接口定义方法和数据传输方法及装置

说明书

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

技术领域

本申请涉及计算机技术领域，尤其涉及一种接口定义方法和数据传输方法及装置。

背景技术

随着计算机技术的发展，由后端设备向前端设备提供数据、由前端设备根据该数据为用户提供服务的模式已经非常普遍。其中，后端设备可以是服务端，前端设备可以是客户端。

例如，客户端可先向服务端发送诸如超文本传输协议(Hyper Text TransferProtocol，HTTP)请求等请求消息，服务端接收到该请求消息后，则根据该请求消息向客户端返回相应的数据，客户端则解析接收到的数据并展现给用户。

但是，如果客户端能够解析的数据的格式与服务端返回的数据的格式不一致，就会导致客户端不能正确的解析服务端返回的数据，因此，这就需要预先定义客户端和服务端之间的接口，使服务端返回的数据的格式能够被客户端正确的解析。

具体的，在现有技术中，一般使用api-blueprint工具来定义接口。由于api-blueprint工具定义接口所使用的是markdown语言，因此，对于用户来说，使用api-blueprint工具定义的接口具有较好的可读性。

然而，虽然markdown语言对用户具有较强的可读性，但其对具体字段的描述能力不足，如，markdown语言不能描述一个字段中的数据是整型还是浮点型，也不能描述数据的取值范围等，这就导致使用markdown语言定义接口的准确性较低。而且，markdown语言只能描述基于HTTP的接口，不能对基于其他协议的接口进行描述，这也导致使用markdown语言定义接口的可扩展性较低。

发明内容

本申请实施例提供一种接口定义方法和数据传输方法及装置，用以解决现有技术中定义接口的准确性和可扩展性较低的问题。

本申请实施例提供的一种接口定义方法，包括：

接口工具采用预设的接口描述语言定义接口；

根据定义的所述接口生成接口文件，其中，所述接口文件中包含原始格式中各字段与目标格式中各字段的对应关系；

将所述接口文件提供给服务端，使所述服务端根据所述接口文件将原始格式的数据转换为目标格式的数据。

本申请实施例提供的一种数据传输方法，包括：

服务端接收请求消息；

根据所述请求消息确定要返回的原始格式的数据；

根据接口工具提供的接口文件中包含的原始格式中各字段与目标格式中各字段的对应关系，将所述原始格式的数据转换为目标格式的数据；

返回转换的目标格式的数据。

本申请实施例提供的一种接口定义装置，包括：

定义模块，用于采用预设的接口描述语言定义接口；

接口文件生成模块，用于根据定义的所述接口生成接口文件，其中，所述接口文件中包含原始格式中各字段与目标格式中各字段的对应关系；