接口文档生成方法、装置、设备、存储介质及程序产品与流程

本申请涉及接口，尤其涉及一种接口文档生成方法、装置、设备、存储介质及程序产品。

背景技术：

1、随着互联网的发展，在用户界面开发过程中涉及的组件也越来越多，当开发人员编写完成组件时，还需要编写组件对应的文档以便于其他开发人员使用组件。其中，接口文档是在软件开发过程中服务使用方和服务提供方之间为了提升协作效率而用以进行相互沟通的一种规范化的接口说明文档，是调用接口的依据。

2、在接口文档生成过程中，基于4层架构的云开发范式，存在大量的dto(datatransfer object，数据传输对象)、po(persistent object，持久化对象)、vo(valueobject，值对象)、pojo(plain old java object，普通老式java对象)等，这些对象可以通过结构化文档的生成组件自动生成，避免机械性重复拷贝，徒增工作量。但是当下的生成组件，不够普适性，更适合特定的场景，在代码更新时，不能保持代码和文档的一致性。

技术实现思路

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、代码生成模块，用于将所述源设计文档输入至预设代码生产模板，得到所述源设计文档对应的接口框架源代码；

30、一致性检查模块，用于在收到一致性检查指令时，检测所述接口框架源代码是否更新；

31、逆向生成模块，用于若所述接口框架源代码更新，则根据所述源设计文档和更新后的接口框架源代码进行逆向生成，获得更新接口文档。

32、此外，为实现上述目的，本申请还提出一种接口文档生成设备，所述设备包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，所述计算机程序配置为实现如上文所述的接口文档生成方法的步骤。

33、此外，为实现上述目的，本申请还提出一种存储介质，所述存储介质为计算机可读存储介质，所述存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现如上文所述的接口文档生成方法的步骤。

34、此外，为实现上述目的，本申请还提供一种计算机程序产品，所述计算机程序产品包括计算机程序，所述计算机程序被处理器执行时实现如上文所述的接口文档生成方法的步骤。

35、本申请提出的一个或多个技术方案，至少具有以下技术效果：本申请首先接收用户输入的接口设计数据，根据预设接口设计文档模板和所述接口设计数据生成源设计文档；然后将所述源设计文档输入至预设代码生产模板，得到所述源设计文档对应的接口框架源代码；接着在收到一致性检查指令时，检测所述接口框架源代码是否更新；若所述接口框架源代码更新，最后则根据所述源设计文档和更新后的接口框架源代码进行逆向生成，获得更新接口文档。由于本申请可快速根据源设计文档对应的更新后的接口框架源代码进行逆向生成，使得接口框架源代码与接口文档相互生成，避免了当下的生成组件在代码更新时代码和文档不一致的情况，从而保持了接口框架源代码和接口文档的一致性。

技术特征：

1.一种接口文档生成方法，其特征在于，所述的方法包括：

2.如权利要求1所述的方法，其特征在于，所述接收用户输入的接口设计数据，根据预设接口设计文档模板和所述接口设计数据生成源设计文档的步骤，包括：

3.如权利要求1所述的方法，其特征在于，所述将所述源设计文档输入至预设代码生产模板，得到所述源设计文档对应的接口框架源代码的步骤，包括：

4.如权利要求1至3中任一项所述的方法，其特征在于，所述将所述源设计文档输入至预设代码生产模板，得到所述源设计文档对应的接口框架源代码的步骤之后，还包括：

5.如权利要求4所述的方法，其特征在于，所述若所述接口框架源代码更新，则根据所述源设计文档和更新后的接口框架源代码进行逆向生成，获得更新接口文档的步骤，包括：

6.如权利要求5所述的方法，其特征在于，所述通过所述多个接口唯一标识和所述源设计文档，对所述更新后的接口框架源代码进行逆向生成，获得更新接口文档的步骤之后，还包括：

7.一种接口文档生成装置，其特征在于，所述装置包括：

8.一种接口文档生成设备，其特征在于，所述设备包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，所述计算机程序配置为实现如权利要求1至6中任一项所述的接口文档生成方法的步骤。

9.一种存储介质，其特征在于，所述存储介质为计算机可读存储介质，所述存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现如权利要求1至6中任一项所述的接口文档生成方法的步骤。

10.一种计算机程序产品，其特征在于，所述计算机程序产品包括计算机程序，所述计算机程序被处理器执行时实现如权利要求1至6中任一项所述的接口文档生成方法的步骤。

技术总结
本申请公开了一种接口文档生成方法、装置、设备、存储介质及程序产品，涉及接口技术领域，该方法包括：接收用户输入的接口设计数据，根据预设接口设计文档模板和接口设计数据生成源设计文档；将源设计文档输入至预设代码生产模板，得到接口框架源代码；在收到一致性检查指令时，检测接口框架源代码是否更新；若接口框架源代码更新，则根据源设计文档和更新后的接口框架源代码进行逆向生成，获得更新接口文档。由于本申请可快速根据源设计文档对应的更新后的接口框架源代码进行逆向生成，使得接口框架源代码与接口文档相互生成，避免了当下的生成组件在代码更新时代码和文档不一致的情况，从而保持了接口框架源代码和接口文档的一致性。

技术研发人员：叶庆云,周挺挺,马超,王平
受保护的技术使用者：招商银行股份有限公司
技术研发日：
技术公布日：2024/12/5