接口文档的生成方法、装置、电子设备及存储介质制造方法及图纸

本发明专利技术实施例涉及一种接口文档的生成方法、装置、电子设备及存储介质，包括：加载接口文档生成工具；获取目标接口的接口代码以及所述接口代码的代码注释；将所述接口代码以及所述代码注释输入至所述接口文档生成工具，得到所述目标接口的接口文档。由此，可以实现通过接口文档生成工具自动生成接口文档，减少工作量，加快工作效率。加快工作效率。加快工作效率。

【技术实现步骤摘要】
接口文档的生成方法、装置、电子设备及存储介质


[0001]本专利技术实施例涉及计算机应用
，尤其涉及一种接口文档的生成方法、装置、电子设备及存储介质。

技术介绍

[0002]以接口的方式提供的开放能力，需要提供接口文档给到需要使用这些接口的企业或者开发商，除了一些标准接口外，还有很多是定制接口，经常需要更改接口的参数。
[0003]现有技术中，新开发接口都需要手写接口文档，导致工作量很大，并且当需求发生变更时，需要修改接口字段，因此接口和文档不容易保持一致。

技术实现思路

[0004]鉴于此，为解决上述开发接口需要手写接口文档，导致工作量很大，以及在修改接口字段时，导致接口和文档不一致的技术问题，本专利技术实施例提供一种接口文档的生成方法、装置、电子设备及存储介质。
[0005]第一方面，本专利技术实施例提供一种接口文档的生成方法，包括：
[0006]加载接口文档生成工具；
[0007]获取目标接口的接口代码以及所述接口代码的代码注释；
[0008]将所述接口代码以及所述代码注释输入至所述接口文档生成工具，得到所述目标接口的接口文档。
[0009]在一可能的实施方式中，所述方法还包括：
[0010]将所述接口文档存储至指定存储介质，并生成所述接口文档在所述指定存储介质中的存储地址。
[0011]在一可能的实施方式中，在所述将所述接口文档存储至指定存储介质，并生成所述接口文档在所述指定存储介质中的存储地址之后，所述方法还包括：
>[0012]当接收到接口文档下载指令时，根据所述存储地址从所述指定存储介质中下载所述接口文档；
[0013]对下载的接口文档进行格式转换，得到JSON格式的接口文档；
[0014]通过浏览器输出所述JSON格式的接口文档。
[0015]在一可能的实施方式中，所述方法还包括：
[0016]在检测到所述目标接口的接口代码发生更新时，将更新后的接口代码以及所述更新后的接口代码的代码注释重新输入至所述接口文档生成工具，得到更新后的所述目标接口的接口文档。
[0017]在一可能的实施方式中，在所述得到更新后的所述目标接口的接口文档之后，所述方法还包括：
[0018]将更新后的所述目标接口的接口文档上传至所述指定存储介质，以更新所述指定存储介质中的所述目标接口的接口文档，以及重新生成所述更新后的接口文档在所述指定
存储介质中的存储地址。
[0019]第二方面，本专利技术实施例提供一种接口文档的生成装置，包括：
[0020]加载模块，用于加载接口文档生成工具；
[0021]获取模块，用于获取目标接口的接口代码以及所述接口代码的代码注释；
[0022]确定模块，用于将所述接口代码以及所述代码注释输入至所述接口文档生成工具，得到所述目标接口的接口文档。
[0023]在一可能的实施方式中，所述装置还包括：
[0024]存储模块，用于将所述接口文档存储至指定存储介质，并生成所述接口文档在所述指定存储介质中的存储地址。
[0025]在一可能的实施方式中，所述装置还包括：
[0026]下载模块，用于在所述将所述接口文档上传存储至指定存储介质，并生成面向所述指定存储介质的接口文档的文档地址之后，执行当接收到接口文档下载指令时，根据所述存储地址从所述指定存储介质中下载所述接口文档；
[0027]转换模块，用于对下载的接口文档进行格式转换，得到JSON格式的接口文档；
[0028]输出模块，用于通过浏览器输出所述JSON格式的接口文档。
[0029]在一可能的实施方式中，所述装置还包括：
[0030]文档确定模块，用于在检测到所述目标接口的接口代码发生更新时，将更新后的接口代码以及所述更新后的接口代码的代码注释重新输入至所述接口文档生成工具，得到更新后的所述目标接口的接口文档。
[0031]在一可能的实施方式中，所述装置还包括：
[0032]文档存储模块，用于在所述得到更新后的所述目标接口的接口文档之后，执行将更新后的所述目标接口的接口文档上传至所述指定存储介质，以更新所述指定存储介质中的所述目标接口的接口文档，以及重新生成所述更新后的接口文档在所述指定存储介质中的存储地址。
[0033]第三方面，本专利技术实施例提供一种电子设备，包括：处理器和存储器，所述处理器用于执行所述存储器中存储的接口文档的生成程序，以实现第一方面中任一项所述的接口文档的生成方法。
[0034]第四方面，本专利技术实施例提供一种存储介质，所述存储介质存储有一个或者多个程序，所述一个或者多个程序可被一个或者多个处理器执行，以实现第一方面中任一项所述的接口文档的生成方法。
[0035]本专利技术实施例提供的技术方案，通过加载接口文档生成工具，再获取到目标接口的接口代码以及接口代码的代码注释，并将该接口代码以及代码注释输入至接口文档生成工具，得到目标接口的接口文档，可以实现自动生成接口文档，减少写文档的工作量，避免了每次新开发接口需要手写接口文档，加快了工作效率，提升用户体验感。
附图说明
[0036]图1为本专利技术实施例提供的一种接口文档的生成方法的实施例流程图；
[0037]图2为本专利技术实施例提供的另一种接口文档的生成方法的实施例流程图；
[0038]图3为本专利技术实施例提供的又一种接口文档的生成方法的实施例流程图；
[0039]图4为本专利技术实施例提供的通过浏览器输出的接口文档的部分页面示意图；
[0040]图5为本专利技术实施例提供的一种接口文档的生成装置的实施例框图；
[0041]图6为本专利技术实施例提供的一种电子设备的结构示意图。
具体实施方式
[0042]为使本专利技术实施例的目的、技术方案和优点更加清楚，下面将结合本专利技术实施例中的附图，对本专利技术实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本专利技术一部分实施例，而不是全部的实施例。基于本专利技术中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本专利技术保护的范围。
[0043]为便于理解，下面结合附图以具体实施例对本专利技术提供的接口文档的生成方法做进一步的解释说明，实施例并不构成对本专利技术实施例的限定。
[0044]参见图1，为本专利技术实施例提供的一种接口文档的生成方法的实施例流程图。在一个例子中，该方法可适用于JAVA语言，可应用于电子设备上，例如平板电脑、台式计算机等，本专利技术实施例对此不做限制。如图1所示，该流程可包括以下步骤：
[0045]S101.加载接口文档生成工具。
[0046]在一实施例中，定义文档生成规则，即定义编写代码注释规范，包括定义接口注释的规范和定义参数注释的规范。举例来说，定义接口注释的规范示例：
[0047][0048][0049]根据上述设定的文档生成规则，可以使用功能组件加载接口文档生成工具，其中，该功能组件本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档的生成方法，其特征在于，包括：加载接口文档生成工具；获取目标接口的接口代码以及所述接口代码的代码注释；将所述接口代码以及所述代码注释输入至所述接口文档生成工具，得到所述目标接口的接口文档。2.根据权利要求1所述的方法，其特征在于，所述方法还包括：将所述接口文档存储至指定存储介质，并生成所述接口文档在所述指定存储介质中的存储地址。3.根据权利要求2所述的方法，其特征在于，在所述将所述接口文档存储至指定存储介质，并生成所述接口文档在所述指定存储介质中的存储地址之后，所述方法还包括：当接收到接口文档下载指令时，根据所述存储地址从所述指定存储介质中下载所述接口文档；对下载的接口文档进行格式转换，得到JSON格式的接口文档；通过浏览器输出所述JSON格式的接口文档。4.根据权利要求2所述的方法，其特征在于，所述方法还包括：在检测到所述目标接口的接口代码发生更新时，将更新后的接口代码以及所述更新后的接口代码的代码注释重新输入至所述接口文档生成工具，得到更新后的所述目标接口的接口文档。5.根据权利要求4所述的方法，其特征在于，在所述得到更新后的所述目标接口的接口文档之后，所述方法还包括：将更新后的所述目标接口的接口文档上传至所述指定存储介质，以更新所述指定存储介质中的所述目标接口的接口文档，以及重新生成所述更新后的接口文档在所述指定存储介...

【专利技术属性】
技术研发人员：刘玉丹，罗锦江，
申请(专利权)人：广东三维家信息科技有限公司，
类型：发明
国别省市：