[发明专利]检测JS程序的API数据类型的方法装置、介质和设备

说明书

本公开提供了一种检测JS程序的API数据类型的方法、装置、介质和设备，该方法包括：解析IDS文件得到API请求数据和返回数据的IDS数据类型；将所述IDS数据类型映射为JS数据类型；根据所述JS数据类型生成类型检测函数；在API的库代码中调用所述类型检测函数对所述请求数据和/或返回数据进行类型检测。本公开生成的JS类型检测代码可以帮助开发者及时发现不符合预期类型的数据，能有效地提升API的联调效率和提高JS的代码质量。

技术领域

本公开涉及计算机技术领域，具体而言，涉及一种基于IDS文件的检测JS程序的API数据类型的方法、装置、介质和电子设备。

背景技术

JavaScript(简称JS)是一种解释型语言，没有传统的编译过程，因此无法在运行前知道JS程序中的错误。另外，JS又是一种弱类型语言，在定义JS变量时，不需要声明变量类型，不同类型的变量可以相互赋值，因此，JS没有类型检测能力。如果开发者在JS程序中传入了不符合预期类型的变量，JS程序运行时并不会报错，也不会有任何提示，潜在的Bug很难被发现。现有技术中，开发了一些代码规范检测工具，比如Eslint。这些工具可以帮助开发者发现一些Bug，比如直接使用未定义的变量，但是没办法检测变量类型的合法性。

TypeScript(简称TS)是JS的超集，开发者编写TS程序时需要指定变量的类型。TS编译器会检测类型的合法性，并把TS代码编译成 JS代码。TS解决了JS不能进行类型检测的问题，有效地提升了代码的质量，使用越来越广泛。但是，TS会增加很多学习成本和开发维护成本。另外，TS使用的是静态类型检测，没办法发现动态类型问题。比如，TS无法检测API调用返回的数据的类型是否符合预期。

在进行(Application Programming Interface，应用程序编程接口) API开发时，开发者一般会先按照某种IDS(Interface Description Specification，接口定义规范)写接口文档，比如OAS(OpenAPI Specification，开放接口规范)、Thrift IDL(InterfaceDescription Language，接口定义语言)和Protocol Buffers Language。这些IDS文件可以用来生成代码库。但是，现有的工具根据IDS生成的JS代码库并没有类型检测的能力。对于生成RPC(Remote Procedure Call，远程过程调用)API代码库的情况，开发者如果给API传入或返回了一个和IDS定义类型不一致的数据，数据能够顺利被序列化，反序列化的时候会得到不符合预期的数据或者抛出解析异常。对于生成HTTP (HyperText TransferProtocol，超文本传输协议)API代码库的情况，程序不会抛出任何异常。因此，发现或定位API传入或返回的数据不符合IDS定义类型的问题的成本比较高，不利于提升API的联调效率和提高JS的代码质量。

公开内容

本公开的目的在于提供一种基于IDS文件的检测JS程序的API数据类型的方法、装置、介质和电子设备，能够解决上述提到的至少一个技术问题。具体方案如下：

根据本公开的具体实施方式，第一方面，本公开提供一种基于IDS 文件的检测JS程序的API数据类型的方法，包括：

解析IDS文件得到API请求数据和返回数据的IDS数据类型；

将所述IDS数据类型映射为JS数据类型；

根据所述JS数据类型生成类型检测函数；

在API的库代码中调用所述类型检测函数对所述请求数据和/或返回数据进行类型检测。

可选的，所述根据所述JS数据类型生成类型检测函数，包括：

根据所述JS数据类型生成通用检测函数和专项检测函数。