[发明专利]一种基于API文档的API开发管理方法及装置

说明书

本发明提供一种基于API文档的API开发管理方法及装置，可用于金融领域或其他技术领域。所述方法包括：提取API文档所对应的API源码中的IO相关代码或调用码中的IO相关代码；将IO相关代码与API文档所对应的IO规则进行比对，确定IO相关代码与IO规则是否相符；若IO相关代码与IO规则不相符，则根据IO相关代码与IO规则之间的差异生成差异通知信息。所述装置用于执行上述方法。本发明实施例提供的基于API文档的API开发管理方法及装置，能够及时发现API源码与设计的差异以及调用码的缺陷，以使研发人员能够根据该差异或缺陷检查代码并及时作出调整，提高了研发效率。

技术领域

本发明涉及计算机技术领域，具体涉及一种基于API文档的API开发管理方法及装置。

背景技术

大型的IT(Internet Technology)系统通常会划分为多个子系统，各子系统由不同的开发测试团队负责研发维护，子系统间多存在相互依赖调用关系，开发人员通过API(Application Programming Interface，应用程序接口)说明文档作为编程依据实现API调用，编码完毕后通过双方的联调测试进行验证。

然而，目前的这种验证方法，当API非现成需同步研发时，API的设计文档存在频繁变更的可能性，程序疏通调试的过程会因此花费大量时间；且在API的提供方与调用方为不同的研发团队，大型的IT企业甚至存在两地办公的情况时，日常工作交流不方便；另外，由于API本身输入项数量多数据关联逻辑复杂，调用方本身需要花费大量的排查错误时间。这些问题均会大大影响研发效率。

发明内容

针对现有技术中的问题，本发明实施例提供一种基于API文档的API开发管理方法及装置，能够至少部分地解决现有技术中存在的问题。

一方面，本发明提出一种基于API文档的API开发管理方法，包括：提取API文档所对应的API源码中的IO相关代码或调用码中的IO相关代码；将提取的所述IO相关代码与所述API文档所对应的IO规则进行比对，确定所述IO相关代码与所述IO规则是否相符；若所述IO相关代码与所述IO规则不相符，则根据所述IO相关代码与所述IO规则之间的差异生成差异通知信息。

可选的，在将提取的所述IO相关代码与所述API文档所对应的IO规则进行比对之前，所述方法还包括：在IO规则库中提取所述API文档所对应的IO规则；若所述API文档最新的修改时间晚于所述IO规则最新的更新时间，则在所述API文档中重新提取IO规则并将重新提取的IO规则更新至所述IO规则库。

可选的，提取API文档所对应的API源码中的IO相关代码包括：提取API文档所对应的API源码对象声明部分中的类属性信息；所述将提取的所述IO相关代码与所述API文档所对应的IO规则进行比对，确定所述IO相关代码与所述IO规则是否相符包括：将提取的所述类属性信息与所述IO规则进行比对，确定所述类属性信息与所述IO规则是否相符。

可选的，所述将提取的所述类属性信息与所述IO规则进行比对，确定所述类属性信息与所述IO规则是否相符包括：分别以所述类属性信息以及所述IO规则为基准，对所述类属性信息和所述IO规则进行比对，确定所述类属性信息与所述IO规则是否相符。

可选的，提取API文档所对应的调用码中的IO相关代码包括：获取所述API文档所对应的IO规则中的每个IO对象的对象名；根据各所述IO对象的对象名，按照语法规则库中的语法规则在所述API文档所对应的调用码中查找每个IO对象的赋值；所述将提取的所述IO相关代码与所述API文档所对应的IO规则进行比对，确定所述IO相关代码与所述IO规则是否相符包括：将每个所述IO对象的赋值与所述IO规则进行比对，确定每个所述IO对象的赋值是否符合所述IO规则。