[发明专利]一种接口文档生成方法、装置、设备及可读存储介质

说明书

本发明公开了一种接口文档生成方法、装置、设备及可读存储介质，其中，该方法包括：获取Protocol Buffers协议对应的原始文件；对原始文件进行编译，生成编译文件，编译文件包含接口及接口依赖信息；解析编译文件，生成接口文档，接口文档包含有接口信息。通过实施本发明，能够得到原始文件所依赖的其他接口信息，得到原始文件对应的完整接口信息，进而生成完整的接口文档，克服了直接解析原始文件而导致的接口文档不完整，接口信息丢失的问题。

技术领域

本发明涉及计算机软件技术领域，具体涉及一种接口文档生成方法、装置、设备及可读存储介质。

背景技术

随着软件复杂度越来越高，交互实时性的要求越来越高，更多的公司选择从JSON和XML等数据结构化强的协议转向Google Protocol Buffers数据序列化强的协议。虽然Google Protocol Buffers具有灵活、高效、更小、更快、更简单的优点，但是GoogleProtocol Buffers协议有高效的传输速率，是因为牺牲了可读性。现有技术通常是基于.proto文件进行解析，而直接编辑.proto原始文件需要相关操作人员都必须要熟练掌握该协议，且当.proto原始文件中存在依赖关系时，无法解析出来完整的接口文档，导致接口文档不完整，接口信息丢失。

发明内容

因此，本发明要解决的技术问题在于克服现有技术中基于.proto原始文件的解析无法解决依赖关联问题，导致接口文档解析不完整，接口信息丢失的问题，从而提供一种接口文档生成方法、装置、设备及可读存储介质。

根据第一方面，本发明实施例提供一种接口文档生成方法，包括：获取ProtocolBuffers协议对应的原始文件；对所述原始文件进行编译，生成编译文件，所述编译文件包含接口及接口依赖信息；解析所述编译文件，生成接口文档，所述接口文档包含有接口信息。

结合第一方面，在第一方面的第一实施方式中，当所述原始文件包含多个时，对多个所述原始文件进行合并。

结合第一方面，在第一方面的第二实施方式中，在所述生成接口文档之后，还包括：判断数据库中是否存在与所述接口文档对应的历史接口文档；若所述数据库中存在与所述接口文档对应的历史接口文档，则更新所述历史接口文档。

结合第一方面第二实施方式，在第一方面的第三实施方式中，所述更新所述历史接口文档包括：获取所述接口文档的第一参数与所述历史接口文档的第二参数，判断所述第一参数和所述第二参数是否一致；若所述第一参数和所述第二参数不一致，则将所述第二参数更新为所述第一参数。

结合第一方面第三实施方式，在第一方面的第四实施方式中，所述接口文档生成方法还包括：保存所述第二参数。

结合第一方面第二实施方式，在第一方面的第五实施方式中，在所述生成接口文档之后，还包括：若所述数据库中不存在与所述接口文档对应的历史接口文档，则将生成的所述接口文档保存至所述数据库。

结合第一方面，在第一方面的第六实施方式中，所述接口文档生成方法还包括：显示所述接口文档对应的接口。

根据第二方面，本发明实施例提供一种接口文档生成装置，包括：获取模块，用于获取Protocol Buffers协议对应的原始文件；编译模块，用于对所述原始文件进行编译，生成编译文件，所述编译文件包含接口及接口依赖信息；生成模块，用于解析所述编译文件，生成接口文档，所述接口文档包含有接口信息。

根据第三方面，本发明实施例提供一种计算机设备，包括：存储器和处理器，所述存储器和所述处理器之间互相通信连接，所述存储器中存储有计算机指令，所述处理器通过执行所述计算机指令，从而执行第一方面或第一方面任一实施方式所述的接口文档生成方法。