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

权利要求书

1.一种接口文档处理方法，其特征在于，包括：

获取用户编写接口注释代码时输入的部分注释代码，确定并显示与所述部分注释代码匹配的候选注释代码；

响应用户的选择操作从所述候选注释代码中选择出目标注释代码，并基于所述目标注释代码得到所述接口注释代码；

将所述接口注释代码转换为注释文档，并基于所述注释文档生成接口文档页面；其中，所述接口文档页面为H5页面；

在得到所述接口注释代码后，所述接口文档处理方法还包括：

判断所述接口注释代码是否满足注释语法规则；

如果所述接口注释代码满足所述注释语法规则，则执行将所述接口注释代码转换为注释文档的过程；

如果所述接口注释代码不满足所述注释语法规则，则确定所述接口注释代码中的错误位置，并进行提示。

2.根据权利要求1所述的接口文档处理方法，其特征在于，所述接口文档处理方法还包括：

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

3.根据权利要求2所述的接口文档处理方法，其特征在于，所述接口文档处理方法还包括：

获取一开发辅助工具，将所述开发辅助工具导入用于编写所述接口注释代码的集成开发环境中；

其中，所述开发辅助工具包含注释语法规则以及注释代码，用于在用户输入部分注释代码时，进行语法提示并辅助进行注释代码补全。

4.根据权利要求1至3中任一项所述的接口文档处理方法，其特征在于，所述接口文档处理方法还包括：

获取编写所述接口注释代码的用户信息；

基于所述用户信息为所述接口文档页面配置白名单访问权限；

其中，如果访问者的标识不在白名单内，则提示所述访问者不具备权限。

5.根据权利要求1至3中任一项所述的接口文档处理方法，其特征在于，所述接口文档处理方法还包括：

获取所述接口文档页面；

从所述接口文档页面中提取接口请求和相应数据内容格式，进行在线接口测试。

6.一种接口文档处理装置，其特征在于，包括：

候选代码确定模块，用于获取用户编写接口注释代码时输入的部分注释代码，确定并显示与所述部分注释代码匹配的候选注释代码；

接口注释代码生成模块，用于响应用户的选择操作从所述候选注释代码中选择出目标注释代码，并基于所述目标注释代码得到所述接口注释代码；

文档页面生成模块，用于将所述接口注释代码转换为注释文档，并基于所述注释文档生成接口文档页面；其中，所述接口文档页面为H5页面；

在获取所述接口注释代码后，所述文档页面生成装置还用于判断所述接口注释代码是否满足注释语法规则；

其中，如果所述接口注释代码满足所述注释语法规则，则所述接口文档生成装置执行将所述接口注释代码转换为注释文档的过程；如果所述接口注释代码不满足所述注释语法规则，则所述接口文档生成装置确定所述接口注释代码中的错误位置，并进行提示。

7.一种接口文档处理系统，其特征在于，包括：

接口开发端，用于获取用户编写接口注释代码时输入的部分注释代码，确定并显示与所述部分注释代码匹配的候选注释代码，响应用户的选择操作从所述候选注释代码中选择出目标注释代码，并基于所述目标注释代码得到所述接口注释代码；

接口文档生成装置，用于获取所述接口注释代码，将所述接口注释代码转换为注释文档，并基于所述注释文档生成接口文档页面；其中，所述接口文档页面为H5页面；

在获取所述接口注释代码后，所述接口文档生成装置还用于判断所述接口注释代码是否满足注释语法规则；

其中，如果所述接口注释代码满足所述注释语法规则，则所述接口文档生成装置执行将所述接口注释代码转换为注释文档的过程；如果所述接口注释代码不满足所述注释语法规则，则所述接口文档生成装置确定所述接口注释代码中的错误位置，并进行提示。