[发明专利]接口文档处理方法及装置、系统、存储介质和电子设备

说明书

本发明公开了一种接口文档处理方法、接口文档处理装置、接口文档处理系统、存储介质和电子设备，涉及计算机技术领域。该接口文档处理方法包括：获取用户编写接口注释代码时输入的部分注释代码，确定并显示与所述部分注释代码匹配的候选注释代码；响应用户的选择操作从候选注释代码中选择出目标注释代码，并基于目标注释代码得到接口注释代码；将接口注释代码转换为注释文档，并基于注释文档生成接口文档页面。本公开可以自动生成接口文档。

技术领域

本公开涉及计算机技术领域，具体而言，涉及一种接口文档处理方法、接口文档处理装置、接口文档处理系统、存储介质和电子设备。

背景技术

在软件项目开发过程中，需要调用接口来完成相应的软件设计，而接口的使用离不开接口文档。目前，传统的接口文档处理都是通过人工的方式来完成。

然而，现有的人工介入方式，维护难度大、易出错且成本高。

需要说明的是，在上述背景技术部分公开的信息仅用于加强对本公开的背景的理解，因此可以包括不构成对本领域普通技术人员已知的现有技术的信息。

发明内容

本公开的目的在于提供一种接口文档处理方法、接口文档处理装置、接口文档处理系统、存储介质和电子设备，进而至少在一定程度上克服由于人工处理接口文档而导致易出错且成本高的问题。

根据本公开的第一方面，提供一种接口文档处理方法，包括：获取用户编写接口注释代码时输入的部分注释代码，确定并显示与所述部分注释代码匹配的候选注释代码；响应用户的选择操作从所述候选注释代码中选择出目标注释代码，并基于目标注释代码得到接口注释代码；将接口注释代码转换为注释文档，并基于注释文档生成接口文档页面。

可选地，接口文档处理方法还包括：在获取用户编写接口注释代码时输入的部分注释代码时，确定并显示出与所述部分注释代码对应的语法规则，以供用户进行编写参考。

可选地，接口文档处理方法还包括：获取一开发辅助工具，将开发辅助工具导入用于编写接口注释代码的集成开发环境中；其中，开发辅助工具包含注释语法规则以及注释代码，用于在用户输入部分注释代码时，进行语法提示并辅助进行注释代码补全。

可选地，接口文档处理方法还包括：在得到接口注释代码后，判断所述接口注释代码是否满足注释语法规则；如果所述接口注释代码满足所述注释语法规则，则执行将所述接口注释代码转换为注释文档的过程；如果所述接口注释代码不满足所述注释语法规则，则确定所述接口注释代码中的错误位置，并进行提示。

可选地，所述接口文档处理方法还包括：获取编写所述接口注释代码的用户信息；基于所述用户信息为所述接口文档页面配置白名单访问权限；其中，如果访问者的标识不在白名单内，则提示所述访问者不具备权限。

可选地，所述接口文档处理方法还包括：获取所述接口文档页面；从所述接口文档页面中提取接口请求和相应数据内容格式，进行在线接口测试。

根据本公开的第二方面，提供一种接口文档处理装置，包括候选代码确定模块、接口注释代码生成模块和文档页面生成模块。

具体的，候选代码确定模块用于获取用户编写接口注释代码时输入的部分注释代码，确定并显示与所述部分注释代码匹配的候选注释代码；接口注释代码生成模块用于响应用户的选择操作从候选注释代码中选择出目标注释代码，并基于目标注释代码得到所述接口注释代码；文档页面生成模块用于将接口注释代码转换为注释文档，并基于注释文档生成接口文档页面。

可选地，接口文档处理装置还包括语法提示模块。

具体的，语法提示模块用于在获取用户编写接口注释代码时输入的部分注释代码时，确定并显示出与所述部分注释代码对应的语法规则，以供用户进行编写参考。

可选地，接口文档处理装置还包括工具导入模块。