[发明专利]一种接口文档的处理方法、装置、计算机设备和存储介质

说明书

本申请涉及一种接口文档的处理方法、装置、计算机设备和存储介质，包括：响应服务端的接口特征校验请求，从接口特征校验请求中确定待校验接口的接口标识；获取接口标识对应的预设接口特征信息；预设接口特征信息为初始接口文档对应的接口特征信息，初始接口文档根据服务端的初始接口代码生成；确定服务端的当前接口代码，并获取当前接口代码对应的当前接口特征信息；当前接口特征信息为当前接口代码文档对应的接口特征信息，当前接口代码文档根据当前接口代码生成；在当前接口特征信息与预设接口特征信息不匹配时，对初始接口文档进行更新。实现根据接口代码生成接口文档，提高接口文档的生成效率，保证服务端运行的接口代码与接口文档的一致性。

技术领域

本申请涉及计算机技术领域，特别是涉及一种接口文档的处理方法、装置、计算机设备和存储介质。

背景技术

随着互联网技术的发展，越来越多的应用通过接口获取网络中由服务端提供的服务。

在现有技术中，接口具有对应的接口文档，接口文档可以描述接口的规范和内容，客户端开发人员可以根据接口文档编写与服务端进行交互的代码，以使客户端按照接口文档的规范和内容与服务端进行交互。在接口的使用过程中，为了适应多变的业务变化需求，服务端代码中的接口代码可以经过多次变化，接口文档也将产生不同的版本。在接口发生变化时，可以依靠人工对接口文档进行维护，使客户端开发人员可以根据维护后的接口文档编写代码。

然而，采用人工方式对接口文档进行维护，在接口代码发生变化时难以同步更新接口文档，导致服务端实际运行的接口代码与接口文档不一致。

发明内容

基于此，有必要针对上述技术问题，提供一种能够确保服务端实际运行的接口代码与接口文档一致的接口文档的处理方法、装置、计算机设备和存储介质。

一种接口文档的处理方法，所述方法包括：

响应于服务端的接口特征校验请求，从所述接口特征校验请求中确定待校验接口的接口标识；

获取所述接口标识对应的预设接口特征信息；其中，所述预设接口特征信息为初始接口文档对应的接口特征信息，所述初始接口文档根据所述服务端的初始接口代码生成；

确定所述服务端的当前接口代码，并获取所述当前接口代码对应的当前接口特征信息；其中，所述当前接口特征信息为当前接口代码文档对应的接口特征信息，所述当前接口代码文档根据所述当前接口代码生成；

当所述当前接口特征信息与所述预设接口特征信息不匹配时，对所述初始接口文档进行更新。

可选地，所述获取所述当前接口代码对应的当前接口特征信息，包括：

基于反射机制，生成所述当前接口代码对应的当前接口文档；

根据所述当前接口文档中包含的信息，获取所述当前接口文档对应的当前接口特征信息。

可选地，所述根据所述当前接口文档中包含的信息，获取所述当前接口文档对应的当前接口特征信息，包括：

从所述当前接口文档中获取请求参数信息、返回参数信息以及授权信息；

确定所述请求参数信息对应的第一参数特征信息和所述返回参数信息对应的第二参数特征信息；

根据所述第一参数特征信息、所述第二参数特征信息以及所述授权信息，确定当前接口特征信息。

可选地，所述请求参数信息包括多个请求字段，所述确定所述请求参数信息对应的第一参数特征信息，包括：

针对每个请求字段，确定请求字段对应的请求字段类型信息、请求字段标识以及请求字段重要性级别信息；采用所述请求字段类型信息、请求字段标识，以及请求字段重要性级别信息，生成第一字符串，并确定所述第一字符串对应的字符串特征信息；