【技术实现步骤摘要】
本申请属于人工智能，尤其涉及一种接口文档的生成方法、装置、设备、存储介质及程序产品。
技术介绍
1、接口文档是一种用于描述软件组件、库、框架或服务可用功能及其使用方式的文档。目前，传统的接口文档处理都是通过人工的方式来进行手动编写。
2、然而，编写接口文档是一项繁琐的任务，特别是在大型项目中，接口数量众多，人工编写接口文档将耗费用户大量的时间和精力，从而导致编写接口文档的效率低下。
技术实现思路
1、本申请实施例提供了一种接口文档的生成方法、装置、设备、存储介质及程序产品，能够解决现有的人工编写接口文档的效率低下的问题。
2、第一方面，本申请实施例提供一种接口文档的生成方法，方法包括：
3、在接收到接口文档的生成请求的情况下，确定所述生成请求对应的接口，并获取所述接口的请求地址；
4、基于所述请求地址生成所述接口的请求路径，通过访问所述接口的请求路径获取所述接口的第一接口信息，其中，所述第一接口信息包括所述接口中各项参数相关的参数信息；
5、基于所述第一接口信息的属性特征获取所述第一接口信息对应的接口文档模板，将所述第一接口信息填充至所述接口文档模板中，生成所述接口文档。
6、在一些实施例中，所述通过访问所述接口的请求路径获取所述接口的第一接口信息之前，所述方法还包括：
7、接收用户输入的接口要素信息；
8、按照所述接口要素信息的类别将所述输入的接口要素信息定义到所述接口中，生成所述接口
9、在一些实施例中，所述第一接口信息包括所述接口的请求路径、所述接口中参数名称、参数类型以及参数属性。
10、在一些实施例中，所述将所述第一接口信息填充至所述接口文档模板中之前，所述方法还包括：
11、接收用户的文档编写输入；
12、响应于所述文档编写输入，根据所述文档编写输入对应的文档编写操作生成第一文档；
13、对所述第一文档进行格式转换，生成第二文档；
14、利用参数变量替换所述第二文档中的接口信息字段，生成所述接口文档模板。
15、在一些实施例中，所述基于所述第一接口信息的属性特征获取所述第一接口信息对应的接口文档模板，将所述第一接口信息填充至所述接口文档模板中，生成所述接口文档，包括：
16、基于所述第一接口信息的属性特征确定所述第一接口信息对应的参数变量；
17、将所述接口文档模板中的参数变量替换为所述参数变量对应的第一接口信息，生成所述接口文档。
18、在一些实施例中，所述基于所述第一接口信息的属性特征获取所述第一接口信息对应的接口文档模板，将所述第一接口信息填充至所述接口文档模板中，生成所述接口文档之后，所述方法还包括：
19、在检测到所述接口中的第一接口信息更新为第二接口信息的情况下，通过访问所述请求地址获取更新后的所述第二接口信息；
20、将所述接口文档中的所述第一接口信息更新为所述第二接口信息。
21、第二方面，本申请实施例提供一种接口文档的生成装置，装置包括：
22、第一获取模块，用于在接收到接口文档的生成请求的情况下，确定所述生成请求对应的接口，并获取所述接口的请求地址；
23、第二获取模块，用于基于所述请求地址生成所述接口的请求路径，通过访问所述接口的请求路径获取所述接口的第一接口信息，其中，所述第一接口信息包括所述接口中各项参数相关的参数信息；
24、填充模块，用于基于所述第一接口信息的属性特征获取所述第一接口信息对应的接口文档模板，将所述第一接口信息填充至所述接口文档模板中，生成所述接口文档。
25、第三方面，本申请实施例提供了一种接口文档的生成设备，设备包括：处理器以及存储有计算机程序指令的存储器；
26、处理器执行计算机程序指令时实现如上的接口文档的生成方法。
27、第四方面，本申请实施例提供了一种计算机存储介质，计算机存储介质上存储有计算机程序指令，计算机程序指令被处理器执行时实现如上的接口文档的生成方法。
28、第五方面，本申请实施例提供了一种计算机程序产品，所述计算机程序产品包括计算机程序指令，所述计算机程序指令被处理器执行时实现如上的接口文档的生成方法。
29、在本申请中，可以在接收到接口文档的生成请求的情况下，确定所述生成请求对应的接口，并获取所述接口的请求地址，通过访问接口的请求地址对应的请求路径可以获取接口的第一接口信息，然后将第一接口信息填充至预先设置的接口文档模板中，生成接口文档。这样一来，每当接口的代码中定义好了接口信息，即可以自动获取接口中的接口信息，并将接口信息填充至接口模板中以快速准确的生成接口文档，和人工编写接口文档相比，提高了接口文档的生成效率。
本文档来自技高网...【技术保护点】
1.一种接口文档的生成方法，其特征在于，所述方法包括：
2.根据权利要求1所述的接口文档的生成方法，其特征在于，所述通过访问所述接口的请求路径获取所述接口的第一接口信息之前，所述方法还包括：
3.根据权利要求1所述的接口文档的生成方法，其特征在于，所述第一接口信息包括所述接口的请求路径、所述接口中参数名称、参数类型以及参数属性。
4.根据权利要求1所述的接口文档的生成方法，其特征在于，所述将所述第一接口信息填充至所述接口文档模板中之前，所述方法还包括：
5.根据权利要求4所述的接口文档的生成方法，其特征在于，所述将所述第一接口信息填充至所述接口文档模板中，生成所述接口文档，包括：
6.根据权利要求1所述的接口文档的生成方法，其特征在于，所述将所述第一接口信息填充至所述接口文档模板中，生成所述接口文档之后，所述方法还包括：
7.一种接口文档的生成装置，其特征在于，所述装置包括：
8.一种接口文档的生成设备，其特征在于，所述接口文档的生成设备包括：处理器以及存储有计算机程序指令的存储器；
10.一种计算机程序产品，其特征在于，所述计算机程序产品包括计算机程序指令，所述计算机程序指令被处理器执行时实现权利要求1-6中任一项所述的接口文档的生成方法。
...【技术特征摘要】
1.一种接口文档的生成方法，其特征在于，所述方法包括：
2.根据权利要求1所述的接口文档的生成方法，其特征在于，所述通过访问所述接口的请求路径获取所述接口的第一接口信息之前，所述方法还包括：
3.根据权利要求1所述的接口文档的生成方法，其特征在于，所述第一接口信息包括所述接口的请求路径、所述接口中参数名称、参数类型以及参数属性。
4.根据权利要求1所述的接口文档的生成方法，其特征在于，所述将所述第一接口信息填充至所述接口文档模板中之前，所述方法还包括：
5.根据权利要求4所述的接口文档的生成方法，其特征在于，所述将所述第一接口信息填充至所述接口文档模板中，生成所述接口文档，包括：
6.根据权利要求1...
【专利技术属性】
技术研发人员：李彦霆，
申请(专利权)人：中国建设银行股份有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。