一种API接口文档管理方法、系统、电子设备及介质与流程

本技术涉及文档管理，具体涉及一种api 接口文档管理方法、系统、电子设备及介质。

背景技术：

1、随着互联网技术的发展，api(应用程序接口)在系统和服务之间实现数据交换及功能对接方面发挥着重要作用。但是，api的数量庞大，接口规范复杂，使得api的管理和文档维护成为一个难题。

2、目前，传统的api接口文档管理方法是通过手动编写和维护文档来描述和记录api接口的使用方法和参数。开发人员根据接口的定义和实现，编写文档内容，包括接口的路径、参数、请求和响应的数据结构等信息。

3、但是在实际应用中，传统的api接口文档管理方法在接入时需要开发人员阅读指定的接入文档，没有统一的接入文档，且接入时要写侵入式代码导致开发人员对接api接口工作效率低的问题。因此，目前用于api接口文档的管理方法亟待改进。

技术实现思路

1、本技术提供了一种api 接口文档管理方法、系统、电子设备及介质，具有简化开发人员对接api接口步骤，提高接口对应工作效率的效果。

2、第一方面，本技术提供了一种api 接口文档管理方法，包括：

3、获取接口文档信息，并提取所述接口文档信息中的注释信息；

4、调取对应的预设解析包，解析所述注释信息，得到接口参数信息；

5、根据所述接口参数信息，按照预设规范组装对应的接口数据以建立对应的目标接口与用户端之间的数据传输。

6、通过采用上述技术方案，系统通过自动提取接口文档信息中的注释信息，并利用预设的解析包对注释信息进行解析，能够自动获取接口的参数信息。在得到接口参数信息的基础上，可以按照预设的规范自动构建接口的数据格式以便前端页面进行接口信息显示和调用，能够通过引入解析包自动解析注释信息获取接口数据进行显示和调用，避免了开发在对接接口时需要写入侵时代码对面api接口，提高了开发人员对接api接口的工作效率。

7、可选的，通过预设网关获取用户请求信息；判断所述用户请求信息中的token在数据库中是否存在对应的有效用户；若是，则授予所述用户请求信息对应的访问权限；若否，则禁止所述用户的访问操作。

8、通过采用上述技术方案，系统通过预设网关从用户请求信息中提取令牌(token)信息。然后系统将提取到的令牌信息与系统中存储的有效令牌对比，判断该令牌是否对应一个真实的注册用户。如果令牌在系统中存在并且未过期，说明对应一个合法的已注册用户。网关将向该用户授予本次请求对应的授权，允许用户向后端服务发起请求。如果令牌在系统中不存在或已过期，说明可能是非法用户发起的请求。网关将拒绝该请求，不向后端服务传递,避免未授权访问。通过本发明设置的网关机制，可以方便高效地验证用户身份并控制请求授权。有效解决了安全性问题，防止未授权访问，保护系统资源和用户隐私数据。

9、可选的，获取用户在应用平台选取的部门名称、项目名称和接口类型信息；根据所述部门名称、项目名称和接口类型信息，查询数据库中对应的所述接口文档信息；根据预设文件读取算法，识别所述接口文档信息得到源代码文件；读取所述源代码文件中注释部分对应的注释信息。

10、通过采用上述技术方案，系统获取用户在应用平台选取的部门名称、项目名称和接口类型信息，根据这些信息查询数据库中对应的接口文档信息，并使用预设文件读取算法识别接口文档信息得到源代码文件，读取源代码文件中注释部分对应的注释信息，从而实现了用户自定义接口文档自动生成注释信息的功能，减少了人工编写注释信息的工作量，提高了编码效率。

11、可选的，检测所述接口类型信息对应的接口类型；若所述接口类型为预设dubbo接口，则调取所述预设dubbo接口对应的预设解析包以识别所述注释信息中的标签、注释内容和结构的字段内容，得到对应的接口的路径、方法类型、参数、请求体、响应信息；将所述接口路径、方法类型、参数、请求体、响应信息作为所述接口参数信息。

12、通过采用上述技术方案，系统检测接口类型信息对应接口类型，若接口类型为预设dubbo接口时，则调用预设dubbo接口对应的预设解析包识别注释信息中的标签、内容和结构部分内容，获取该接口的接口路径、方法类型、参数、请求体、响应信息等接口参数信息，从而避免了开发人员单独对接 api 接口且需要去阅读对接文档，耗费时间长操作繁琐的问题，提高了工作效率和获取接口参数信息的准确性。

13、可选的，若所述接口类型为预设http接口，则调取所述预设http接口对应的预设解析包以创建预设验证注解字段信息，并将所述预设验证注解字段信息填充至openapischema约束参数字段。

14、通过采用上述技术方案，当系统检测到接口类型属于预设的http接口时,程序会自动调取对应的预设解析包，在解析包中含有该接口对应的预设验证注解字段信息。程序会提取这些预设的验证注解字段信息，并自动填充到openapi schema的参数字段约束中，完成字段验证注解的添加。实现了根据不同的预设http接口类型，自动生成相应的验证注解字段，从而大大简化了openapi schema参数验证注解的创建和维护工作，提高了开发效率。

15、可选的，根据所述openapi规范，将所述接口路径、方法类型、参数、请求体、响应信息按照对应的数据结构组成json格式的数据字符串，并将所述数据字符串作为所述接口数据；将所述接口数据存入预设zookeeper服务终端。

16、通过采用上述技术方案，系统将接口路径、方法类型、参数、请求体、响应信息按照openapi规范对应数据结构，生成了json格式的接口数据字符串。然后将生成的接口数据字符串存储到了预设的zookeeper服务终端中。该发明实现了按照openapi规范自动生成接口数据字符串，并集中存入zookeeper的功能，达到了接口数据的规范化组织和集中化存储的效果。这简化了接口数据的管理流程，系统或服务只需要从zookeeper获取json格式的接口数据就可以直接使用，而不需要人工处理接口数据的组织和存储，从而提高了系统的数据利用效率。

17、可选的，读取所述目标接口信息中的interface和method信息，并构建对应的请求url；根据预设post请求的方式，将所述请求url发送至所述预设网关，并通过所述预设网关创建所述请求url对应的dubbo协议；根据所述dubbo协议，向对应的dubbo服务端发送调用请求信息以执行接口调用操作。

18、通过采用上述技术方案，系统读取目标接口信息中的interface和method等信息，构建出请求的url。然后根据预设的post请求方式，将url发送至预设网关，该预设网关根据url创建出对应的dubbo协议，然后根据dubbo协议向对应的dubbo服务端发送调用请求信息以执行接口调用操作，能够解决api接口文档不支持dubbo接口查询和调用的问题，从而实现了dubbo接口的快速、稳定、可靠调用，提高了接口调用的效率和安全性。

19、在本技术的第二方面提供了一种api 接口文档管理方法的系统。

20、信息获取模块，用于获取接口文档信息，并提取所述接口文档信息中的注释信息；

21、数据解析模块，用于调取对应的预设解析包，解析所述注释信息，得到接口参数信息；

22、数据组装模块，用于根据所述接口参数信息，按照预设规范组装对应的接口数据以建立对应的目标接口与用户端之间的数据传输。

23、在本技术的第三方面提供了一种电子设备。

24、一种api 接口文档管理方法的系统，包括存储器、处理器及存储在所述存储器上并可在所述处理器上运行的程序，该程序能够被处理器加载执行时实现一种api 接口文档管理方法。

25、在本技术的第四方面提供了一种计算机可读存储介质。

26、一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，所述计算机程序被处理器执行时使所述处理器实现一种api 接口文档管理方法。

27、综上所述，本技术实施例中提供的一个或多个技术方案，至少具有如下技术效果或优点：

28、1、本技术通过系统提取接口文档信息中的注释信息，并利用预设的解析包对注释信息进行解析，能够自动获取接口的参数信息。在得到接口参数信息的基础上，可以按照预设的规范自动构建接口的数据格式以便前端页面进行接口信息显示和调用，能够通过引入解析包自动解析注释信息获取接口数据进行显示和调用，避免了开发在对接接口时需要写入侵时代码对面api接口，提高了开发人员对接api接口的工作效率。

29、2、本技术通过预设网关识别用户请求信息中的token，并在数据库中比对该token，若是存在对应的有效用户则授予该请求信息权限，若是不存在则禁止该用户请求信息的访问行文，可有效地验证用户身份并控制请求授权，防止未授权访问，保护系统资源和用户隐私数据。

30、3、本技术通过引入对应接口类型的解析包，自动解析接口的注释信息，从而获取注释信息中的接口信息，能够避免多个文档对接不统一的问题，简化对接api接口的操作步骤，提高各企业应用api接口对接效率。