接口文档的生成方法、装置、计算机设备和存储介质制造方法及图纸

本申请揭示了一种接口文档的生成方法、装置、计算机设备和存储介质，其中方法包括：获取第一项目的源代码；从源代码的所有类方法中筛选出带有接口标记的类方法，并将带有接口标记的类方法记为接口类方法；通过反射技术从与接口类方法对应的方法体中提取接口基本信息，以及从方法体对应的代码注解信息中提取接口附加信息；整合接口基本信息与接口附加信息，形成第一接口信息；将第一接口信息添加至预设的接口文档模板内，根据预设的接口文档模板生成与第一接口信息对应的第一接口文档。通过本申请可以自动生成与第一项目的源代码对应的第一接口文档，保证了第一接口文档与第一接口信息的一致性，有效地节省了人力成本，提高了接口文档的生成效率。

Generation method, device, computer equipment and storage medium of interface document

【技术实现步骤摘要】
接口文档的生成方法、装置、计算机设备和存储介质
本申请涉及计算机
，具体涉及一种接口文档的生成方法、装置、计算机设备和存储介质。
技术介绍
随着计算机技术的不断发展，在项目开发的过程中，由于软件系统的复杂度越来越高，导致项目代码量也会越来越大，通常需要许多名开发人员共同协作来完成项目的开发，但是不同的开发人员之间的编程风格相差较大，某一开发人员编写的代码往往难以被另一开发人员理解。因此，为了便于不同的开发人员之间能够相互了解各自编写的代码内容，每个开发人员除了要完成编写代码的任务，还需要提供完善的并与编写的项目代码对应的接口文档。对接口文档进行手工编写会浪费开发人员大量的时间和精力，效率低且容易出错，开发成本高。
技术实现思路
本申请的主要目的为提供一种接口文档的生成方法、装置、计算机设备和存储介质，旨在解决现有的开发人员需要手工编写与项目代码对应的接口文档，浪费了开发人员大量的时间和精力，效率低且容易出错，开发成本高的技术问题。本申请提出一种接口文档的生成方法，所述方法包括步骤：获取第一项目的源代码；从所述源代码的所有类方法中筛选出带有接口标记的类方法，并将所述带有接口标记的类方法记为接口类方法；通过反射技术从与所述接口类方法对应的方法体中提取接口基本信息，以及从所述方法体对应的代码注解信息中提取接口附加信息；整合所述接口基本信息与所述接口附加信息，形成第一接口信息，其中所述第一接口信息至少包括输入参数的名称、输入参数的类型、输出参数的名称、输出参数的类型以及参数注释信息；将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档。可选地，所述获取第一项目的源代码的步骤之前，包括：接收用户输入的第一项目信息，其中所述第一项目信息包括maven坐标；根据所述maven坐标，从预设的程序开发管理工具搜寻出与所述maven坐标对应的所述第一项目；生成获取所述第一项目的源代码的指令。可选地，所述将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档的步骤之后，包括：为所述第一接口文档建立对应的第一索引，并将所述第一索引以及所述第一接口文档上传至预设的文档数据库，其中所述第一接口文档为所述文档数据库包含的所有接口文档中的任意一个接口文档；判断是否接收到用户输入的文档搜索指令；若接收到用户输入的文档搜索指令，则提取出所述文档搜索指令中的搜索关键词；判断所述文档数据库预存储的索引中，是否存在与所述搜索关键词对应的索引项；若存在与所述搜索关键词对应的索引项，则获取所述索引项对应的指定接口文档；通过指定显示页面展示所述指定接口文档。可选地，所述通过指定显示页面展示所述指定接口文档的步骤，包括：创建指定数量的不同形式的显示界面；接收所述用户从所有所述显示界面中选取的第一显示界面；将所述第一显示界面确定为所述指定显示页面，并通过所述第一显示界面展示所述指定接口文档。可选地，所述若存在与所述搜索关键词对应的索引项，则获取所述索引项对应的指定接口文档，并通过指定显示页面展示所述指定接口文档的步骤之后，包括：判断是否接收到所述用户在所述指定显示界面内输入的修改信息；若是，根据所述修改信息对所述指定接口文档进行修改，得到修改后的接口文档；使用所述修改后的接口文档替换所述指定接口文档。可选地，所述将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档的步骤之后，包括：判断所述第一接口文档对应的所述源代码是否产生了修改记录；若所述源代码产生了修改记录，则获取修改后的源代码的指定接口信息，并将所述指定接口信息与预存储的所述源代码的原始接口信息进行对比，得到对比结果，其中所述原始接口信息为修改前的源代码的接口信息；根据所述对比结果，判断所述指定接口信息与所述原始接口信息是否存在差异；若所述指定接口信息与所述原始接口信息存在差异，则根据所述指定接口信息与所述原始接口信息的差异，对所述第一接口文档进行更新。可选地，所述将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档的步骤之后，包括：判断是否接收到所述用户输入的对于指定接口的调试请求，其中所述指定接口为需要进行调试的接口，所述调试请求携带所述指定接口的请求参数；将所述调试请求转发至所述指定接口对应指定项目的应用实例，以通过所述应用实例对所述调试请求进行处理，并得到与所述指定接口的请求参数对应的输出参数；接收所述应用实例返回的所述输出参数，并展示所述输出参数。本申请还提供一种接口文档的生成装置，包括：第一获取模块，用于获取第一项目的源代码；筛选模块，用于从所述源代码的所有类方法中筛选出带有接口标记的类方法，并将所述带有接口标记的类方法记为接口类方法；第一提取模块，用于通过反射技术从与所述接口类方法对应的方法体中提取接口基本信息，以及从所述方法体对应的代码注解信息中提取接口附加信息；整合模块，用于整合所述接口基本信息与所述接口附加信息，形成第一接口信息，其中所述第一接口信息至少包括输入参数的名称、输入参数的类型、输出参数的名称、输出参数的类型以及参数注释信息；添加模块，用于将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档。本申请还提供一种计算机设备，包括存储器和处理器，所述存储器中存储有计算机程序，所述处理器执行所述计算机程序时实现上述方法的步骤。本申请还提供一种计算机可读存储介质，其上存储有计算机程序，所述计算机程序被处理器执行时实现上述方法的步骤。本申请中提供的接口文档的生成方法、装置、计算机设备和存储介质，具有以下有益效果：本申请中提供的接口文档的生成方法、装置、计算机设备和存储介质，获取第一项目的源代码；从所述源代码的所有类方法中筛选出带有接口标记的类方法，并将所述带有接口标记的类方法记为接口类方法；通过反射技术从与所述接口类方法对应的方法体中提取接口基本信息，以及从所述方法体对应的代码注解信息中提取接口附加信息；整合所述接口基本信息与所述接口附加信息，形成第一接口信息，其中所述第一接口信息至少包括输入参数的名称、输入参数的类型、输出参数的名称、输出参数的类型以及参数注释信息；将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档。通过本申请可以自动生成与第一项目的源代码对应的第一接口文档，不需人工编写，保证了第一接口文档与第一接口信息的一致性，有效地节省了人力成本，提高了接口文档的生成效率，而且生成的接口文档的格式统一，便于不同的开发人员进行阅读。附图说明图1是本申请一实施例的接口文档的生成方法的流程示意图；图2是本申请一实施例的接口文档的生成装置的结构示意图；图3是本申请一实施例的计算机设备的结构示意图。本申请目的的实现、功能特点及优点将结合实施例，参照附图做进一步说明。具体实施方式应当理解，此处所描述的具体实施例仅仅用于解释本申请，并不用于限定本申请。需要说明，本申请实施例中所有方向性指示(诸如上、下、左、右、前、后本文档来自技高网...

【技术保护点】
1.一种接口文档的生成方法，其特征在于，包括：获取第一项目的源代码；从所述源代码的所有类方法中筛选出带有接口标记的类方法，并将所述带有接口标记的类方法记为接口类方法；通过反射技术从与所述接口类方法对应的方法体中提取接口基本信息，以及从所述方法体对应的代码注解信息中提取接口附加信息；整合所述接口基本信息与所述接口附加信息，形成第一接口信息，其中所述第一接口信息至少包括输入参数的名称、输入参数的类型、输出参数的名称、输出参数的类型以及参数注释信息；将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档。

【技术特征摘要】
1.一种接口文档的生成方法，其特征在于，包括：获取第一项目的源代码；从所述源代码的所有类方法中筛选出带有接口标记的类方法，并将所述带有接口标记的类方法记为接口类方法；通过反射技术从与所述接口类方法对应的方法体中提取接口基本信息，以及从所述方法体对应的代码注解信息中提取接口附加信息；整合所述接口基本信息与所述接口附加信息，形成第一接口信息，其中所述第一接口信息至少包括输入参数的名称、输入参数的类型、输出参数的名称、输出参数的类型以及参数注释信息；将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档。2.根据权利要求1所述的接口文档的生成方法，其特征在于，所述获取第一项目的源代码的步骤之前，包括：接收用户输入的第一项目信息，其中所述第一项目信息包括maven坐标；根据所述maven坐标，从预设的程序开发管理工具搜寻出与所述maven坐标对应的所述第一项目；生成获取所述第一项目的源代码的指令。3.根据权利要求1所述的接口文档的生成方法，其特征在于，所述将所述第一接口信息添加至预设的接口文档模板内，根据所述预设的接口文档模板生成与所述第一接口信息对应的第一接口文档的步骤之后，包括：为所述第一接口文档建立对应的第一索引，并将所述第一索引以及所述第一接口文档上传至预设的文档数据库，其中所述第一接口文档为所述文档数据库包含的所有接口文档中的任意一个接口文档；判断是否接收到用户输入的文档搜索指令；若接收到用户输入的文档搜索指令，则提取出所述文档搜索指令中的搜索关键词；判断所述文档数据库预存储的索引中，是否存在与所述搜索关键词对应的索引项；若存在与所述搜索关键词对应的索引项，则获取所述索引项对应的指定接口文档；通过指定显示页面展示所述指定接口文档。4.根据权利要求3所述的接口文档的生成方法，其特征在于，所述通过指定显示页面展示所述指定接口文档的步骤，包括：创建指定数量的不同形式的显示界面；接收所述用户从所有所述显示界面中选取的第一显示界面；将所述第一显示界面确定为所述指定显示页面，并通过所述第一显示界面展示所述指定接口文档。5.根据权利要求3所述的接口文档的生成方法，其特征在于，所述通过指定显示页面展示所述指定接口文档的步骤之后，包括：判断是否接收到所述用户在所述指定显示界面内输入的修改信息；若是，根据所述修改信息对所述指定接口文档进行修改，得到修改后的接口文档；使用所述修改后的接口文档替换所述指定...

【专利技术属性】
技术研发人员：王维，
申请(专利权)人：重庆金融资产交易所有限责任公司，
类型：发明
国别省市：重庆,50