接口信息生成方法、装置、设备和存储介质制造方法及图纸

本公开涉及一种接口信息生成方法、装置、设备和存储介质。该方法包括：获取服务通信数据；其中，所述服务通信数据为服务被调用过程中生成的数据；基于所述服务通信数据，确定所述服务包含的至少一个接口的接口描述信息；基于各所述接口描述信息，生成所述服务对应的初始接口描述文档。根据本公开实施例，实现了在接口上线被调用的过程中自动生成接口描述文档，降低了接口描述文档的生成成本，同时提高了接口描述文档的生成效率。了接口描述文档的生成效率。了接口描述文档的生成效率。

Interface information generation method, device, device and storage medium

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


[0001]本公开涉及计算机
，尤其涉及一种接口信息生成方法、装置、设备和存储介质。

技术介绍

[0002]当前，互联网项目开发主要是采用前后端分离的方式，这就要求前端开发人员和后端开发人员互通交互接口来进行共同开发。通常，由后端开发人员提供描述交互接口的详细信息的接口文档。
[0003]目前，后端开发人员主要使用yapi、swagger等接口管理工具来生成接口文档。但是，yapi接口管理工具需要开发人员逐项手动填写接口相关的描述信息，使得接口维护成本较高；swagger接口管理工具虽然可以实现接口自动维护，但其是通过对接口开发代码进行注释的方式来生成接口描述文档，使得接口描述文档的规范性差。
[0004]总之，现有的接口管理工具无法兼顾接口维护成本和接口描述文档的规范性。

技术实现思路

[0005]为了解决上述技术问题，本公开提供了一种接口信息生成方法、装置、设备和存储介质。
[0006]第一方面，本公开提供了一种接口信息生成方法，该方法包括：
[0本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口信息生成方法，其特征在于，包括：获取服务通信数据；其中，所述服务通信数据为服务被调用过程中生成的数据；基于所述服务通信数据，确定所述服务包含的至少一个接口的接口描述信息；基于各所述接口描述信息，生成所述服务对应的初始接口描述文档。2.根据权利要求1所述的方法，其特征在于，所述基于所述服务通信数据，确定所述服务包含的至少一个接口的接口描述信息包括：基于所述服务通信数据，确定任一所述接口对应的接口通信数据；若任一所述接口对应的所述接口通信数据的数据属性信息达到数据处理条件，则对所述接口对应的多个所述接口通信数据进行字段聚合处理，生成所述接口对应的所述接口描述信息。3.根据权利要求1所述的方法，其特征在于，所述基于各所述接口描述信息，生成所述服务对应的初始接口描述文档包括：对所述服务对应的历史接口描述文档和任一所述接口对应的所述接口描述信息进行合并，生成所述初始接口描述文档。4.根据权利要求2所述的方法，其特征在于，所述基于所述服务通信数据，确定任一所述接口对应的接口通信数据包括：按照第一服务标识相同、接口方法相同和接口路径信息符合预设路径规律的方式，对所述通信服务数据进行接口划分，确定各所述接口对应的所述接口通信数据。5.根据权利要求4所述的方法，其特征在于，所述接口通信数据的存储形式为键值对结构；所述键值对结构中的键信息为所述接口通信数据中包含的所述第一服务标识、所述接口方法和目标接口路径信息的组合，所述键值对结构中的值信息为所述接口通信数据；其中，所述目标接口路径信息为符合所述预设路径规律的各所述接口路径信息中的一个。6.根据权利要求2所述的方法，其特征在于，所述对所述接口对应的多个所述接口通信数据进行字段聚合处理，生成所述接口对应的所述接口描述信息包括：基于各所述接口通信数据，确定所述接口中包含的字段标识、每个所述字段标识对应的字段值类型以及每个所述字段标识对应的字段必要性标识；基于所述字段标识、所述字段值类型和所述字段必要性标识确定所述接口描述信息。7.根据权利要求1所述的方法，其特征在于，所述获取服务通信数据包括：从所述服务对应的负载均衡器和/或接口网关中获取所述服务通信数据。...

【专利技术属性】
技术研发人员：郭鲲鹏，
申请(专利权)人：北京字节跳动网络技术有限公司，
类型：发明
国别省市：