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

本公开是关于一种接口文档生成方法、接口文档生成装置、存储介质以及电子设备，涉及计算机技术领域。该方法包括：根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。本公开提高了接口文档的生成效率。率。率。

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


[0001]本公开实施例涉及计算机
，具体而言，涉及一种接口文档生成方法、接口文档生成装置、存储介质以及电子设备。

技术介绍

[0002]在前后端分离的项目开发过程中，为了便于前后端工程师的沟通交流以及后期维护人员的查看、维护，需要由前后端工程师共同定义接口，并编写接口文档。
[0003]目前，接口文档的编写已经由原来的手工编写发展到通过编程来实现遵循openAPI 2.0(open Application Programming Interface，开放应用编程接口)规范的接口文档，但是，仍然存在以下问题：一方面，当应用程序中包括不同应用进程时，相关人员需要记录不同应用服务对应的接口文档的地址，不能对各应用进程对应的接口文档进行统一操作处理；另一方面，应用上线时，需要维护人员对应用进程对应的配置信息进行更改，才能保证应用的正常上线以及接口文档的生成，导致接口文档生成效率较低。
[0004]因此，需要提供一种新的接口文档生成方法。
[0005]需要说明的是，在上述
技术介绍
本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档生成方法，其特征在于，包括：根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。2.根据权利要求1所述的接口文档生成方法，其特征在于，所述接口文档生成方法还包括：从预设的配置中心获取所述当前状态为运行状态的第二目标容器，以及所述第二目标容器中所运行的应用进程的第二配置信息；根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，得到与所述第二配置信息对应的接口文档。3.根据权利要求2所述的接口文档生成方法，其特征在于，获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息，包括：获取所述应用进程的命名空间、名称以及所述应用进程所在的容器集合的名称；根据所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成与所述应用进程对应的第一配置信息。4.根据权利要求3所述的接口文档生成方法，其特征在于，根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档，包括：根据所述第一配置信息中包括的所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成所述第一请求地址；根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档。5.根据权利要求4所述的接口文档生成方法，其特征在于，根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档，包括：在所述应用进程的项目对象模型中引入所述文档生成工具的依赖；基于所述依赖，读取所述应用进程所包括的接口数据，利用所述接口数...

【专利技术属性】
技术研发人员：侯亚东，
申请(专利权)人：京东安联财产保险有限公司，
类型：发明
国别省市：