【技术实现步骤摘要】
接口文档生成方法、装置、设备和计算机存储介质
本专利技术涉及计算机
，尤其涉及接口文档生成方法、装置、设备和计算机存储介质。
技术介绍
随着计算机技术的不断发展，软件系统的复杂度越来越高，代码量也越来越大，一个软件往往需要许多名开发人员共同协作进行开发。由于不同的开发人员之间的编程风格差异较大，一个开发人员编写的代码往往难以被另一开发人员理解。因此，为了便于不同开发人员了解其代码内容，开发人员除了编写代码之外，还需要花费大量的时间和精力编写与代码对应的接口文档，接口文档是用于描述接口程序的内容，例如输入参数的格式、输出参数的格式、接口地址信息和接口描述信息等等；现有的接口文档都是由开发人员手动编写，开发人员需要制作表格、根据接口协议构造复杂的例子以保证接口文档准确性，导致接口文档编写费时，以至于整个软件开发周期延长。
技术实现思路
本专利技术的主要目的在于提供一种接口文档生成方法、装置、设备和计算机存储介质，旨在解决当前接口文档需要开发人员手动编写，接口文档编写效率低，导致软件开发周期较长的...
【技术保护点】
1.一种接口文档生成方法，其特征在于，所述接口文档生成方法包括以下步骤：/n在接收到接口文档生成请求时，获取所述接口文档生成请求中的文件标识，及所述文件标识对应的代码文件；/n根据所述代码文件的语言类型，对所述代码文件中的代码信息进行格式转化；/n将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对，得到所述预设注释信息对应注释的接口代码；/n将所述接口代码对应的预设注释信息作为目标注释信息，将所述接口代码和所述目标注释信息输入到预设文档模板中生成标准接口文档。/n
【技术特征摘要】
1.一种接口文档生成方法，其特征在于，所述接口文档生成方法包括以下步骤：
在接收到接口文档生成请求时，获取所述接口文档生成请求中的文件标识，及所述文件标识对应的代码文件；
根据所述代码文件的语言类型，对所述代码文件中的代码信息进行格式转化；
将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对，得到所述预设注释信息对应注释的接口代码；
将所述接口代码对应的预设注释信息作为目标注释信息，将所述接口代码和所述目标注释信息输入到预设文档模板中生成标准接口文档。
2.如权利要求1所述的接口文档生成方法，其特征在于，所述将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对，得到所述预设注释信息对应注释的接口代码的步骤之前，包括：
查询预设接口文档集合，获取所述预设接口文档集合中各预设接口文档中的接口注释信息，其中，所述接口注释信息包括：接口标识信息、接口调用信息、接口地址信息、接口功能信息、接口入参信息和接口返回值信息；
将所述接口注释信息转化为预设格式的接口注释信息，将所述预设格式的接口注释信息作为预设注释信息，并保存至预设注释集合。
3.如权利要求1所述的接口文档生成方法，其特征在于，所述将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对，得到所述预设注释信息对应注释的接口代码的步骤之前，包括：
获取预设注释集合中的各预设注释信息，及各所述预设注释信息的特征字符串，根据所述特征字符串构建正则表达式；
所述将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对，得到所述预设注释信息对应注释的接口代码的步骤，包括：
根据所述正则表达式检索所述代码信息，得到所述特征字符串对应的代码，并将所述代码作为预设注释信息对应注释接口代码。
4.如权利要求1所述的接口文档生成方法，其特征在于，所述根据所述代码文件的语言类型，对所述代码文件中的代码信息进行格式转化的步骤，包括：
确定所述代码文件的语言类型，查询预设编写规则库，获取所述预设编写规则库中所述语言类型对应的标准方法编写规则；
将所述代码信息中不符合所述标准方法编写规则的代码作为冗余代码，删除所述冗余代码以完成代码信息的格式转化。
5.如权利要求1所述的接口文档生成方法，其特征在于，所述将所述接口代码对应的预设注释信息作为目标注释信息，将所述接口代码和所述目标注释信息输入到预设文档模板中生成标准接口文档的步骤之后，包括：
获取所述标准接口文档的文档标识，建立所述标准接口文档与所述文档标识的关联关系，并将所述文档标识添加至预设目录；
在接收到接口文档查询请求时，查询所述预...
【专利技术属性】
技术研发人员：周俊，
申请(专利权)人：平安普惠企业管理有限公司，
类型：发明
国别省市：广东;44
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。