[发明专利]接口文档生成与查询方法、装置及计算机可读存储介质

说明书

本发明涉及数据处理技术领域，揭露一种接口文档生成与查询方法，包括：获取接口项目创建指令，创建与所述接口项目对应的文档项目，在项目关系表中存储所述接口项目与所述文档项目的关联关系；创建或更新接口项目的功能模块，并在所述文档项目中生成或更新与所述功能模块关联的接口文档；当接收到接口文档查询请求时，根据所述接口文档查询请求中的功能模块标识查找对应的接口文档，并返回所述对应的接口文档。本发明还涉及区块链技术，所述接口文档存储于区块链中。本发明根据功能模块自动生成和管理关联接口，减少了人工编辑文档的成本和后期的维护成本，保证了接口和文档的一致性，从而方便快捷的实现接口文档生成与查询。

技术领域

本发明涉及数据处理技术领域，尤其涉及一种接口文档生成与查询方法、电子装置及计算机可读存储介质。

背景技术

目前，在生成接口文档时，通常将接口的定义作为接口文档，采用一个接口对应一个接口文档的形式，而在接口项目中一个功能模块会涉及到多个接口，需要查看多个接口文档才能预览该功能模块的所有接口，使用不方便。现有技术中，在查询某一接口项目或某一功能模块的接口文档时，需要逐个查询对应的接口文档，当接口项目或功能模块涉及到多个接口时，常将大量接口不加区分地全部展示，不够清晰便捷。

因此，如何方便快捷的实现接口文档生成与查询已经成为一个亟待解决的技术问题。

发明内容

鉴于以上内容，有必要提供一种接口文档生成与查询方法，用于方便快捷的实现接口文档生成与查询。

本发明提供的接口文档生成与查询方法，应用于电子装置，包括：

获取接口项目创建指令，创建与所述接口项目对应的文档项目，在项目关系表中存储所述接口项目与所述文档项目的关联关系；

创建或更新接口项目的功能模块，并在所述文档项目中生成或更新与所述功能模块关联的接口文档；

当接收到接口文档查询请求时，根据所述接口文档查询请求中的功能模块标识查找对应的接口文档，并返回所述对应的接口文档。

可选的，所述在所述文档项目中生成或更新与所述功能模块关联的接口文档包括：

根据文档关联表查询所述文档项目中是否存储与所述功能模块关联的接口文档；

若所述文档项目中未存储与所述功能模块关联的接口文档，生成与所述功能模块关联的接口文档并存储到所述文档项目中，并在文档关联表中存储所述功能模块与所述接口文档的关联关系；

若所述文档项目中存储有与所述功能模块关联的接口文档，更新所述文档项目中与所述功能模块关联的接口文档。

可选的，所述生成与所述功能模块关联的接口文档并存储到所述文档项目中包括：

在所述文档项目中新建接口文档，遍历读取所述功能模块的各个接口信息，并按照预先设置的格式将所述功能模块的各个接口信息写入所述文档项目中新建的接口文档。

可选的，所述更新所述文档项目中与所述功能模块关联的接口文档包括：

遍历读取所述功能模块的各个接口信息，读取与所述功能模块关联的接口文档中文档关联的接口并判断所述功能模块是否有新增、删除或更新接口；

若所述功能模块有新增接口，则将所述新增接口追加至与所述功能模块关联的接口文档中；

若所述功能模块有更新接口，则将更新后的接口替换掉与所述功能模块关联的接口文档中的被更新接口；

若所述功能模块删除了接口，则从与所述功能模块关联的接口文档中移除该接口。

可选的，所述接口项目包括一个或多个功能模块，所述功能模块包括一个或多个接口。