一种基于互联网金融系统从源码生成系统交互的API文档的方法技术方案

本发明专利技术属于信息技术领域，公开了一种基于互联网金融系统从源码生成系统交互的API文档的方法，包括以下几个环节，S1:api管理系统中进行配置环节；S2:开发人员提交代码环节；S3:devops触发事件环节；S4:api管理系统工作环节；S5:静态页面展示环节。本发明专利技术对已有项目的入侵性很小，又能解决新项目的快速接入，能够快速地推广到各个系统，使各个系统都快速地使用起来；同时开发人员也只需要付出较小的对接成本，只需要在对接前提供相应的代码库进行相关的配置即可；而且生成的API文档进行全行的集中管理，同一个口径输出API文档，并且始终保持和源码一致，自动伴随源码的更新而更新。自动伴随源码的更新而更新。自动伴随源码的更新而更新。

【技术实现步骤摘要】
一种基于互联网金融系统从源码生成系统交互的API文档的方法


[0001]本专利技术属于信息
，具体涉及一种基于互联网金融系统从源码生成系统交互的API文档的方法。

技术介绍

[0002]随着互联网银行的业务日益增多，业务创新也日益增多，一个产品的开发可能涉及到几十甚至上百个系统，系统直接的交互都是通过各个系统的API文档进行交互。传统方案是系统间交互采用excel或者world的方式进行系统间的交互，每当系统有API需要更新的时候，即将相应的API文档更新给系统的上下游系统。
[0003]由于互联网业务的日益扩展，系统功能的迭代越来越频繁，系统交互的频率也越来越高，对系统交互的API文档的准确性也越来越高了，采用excel或者world的方式进行系统间的交互的传统方案已经越来越不适应现在的需求。其原因在于，采用传统方案，各个系统在接收到新需求的第一件事情就是编写系统交互的API文档。然后各个系统通过上下游提供的API文档展开相应的代码开发，如果一旦涉及到某个系统的API文档需要更新迭代的时候，会通过开发人员到项目经理到上下游系统，本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种基于互联网金融系统从源码生成系统交互的API文档的方法，其特征在于，包括以下几个环节，S1:api管理系统中进行配置环节，代码开发人员或者系统负责人在api管理系统中进行配置，对系统/应用的相关信息进行配置，为自动生成API文档提供前置条件；S2:开发人员提交代码环节，开发人员接收需求开发代码，同时编写相应的注释，然后直接提交代码到git仓库；S3:devops触发事件环节，代码在进行code+2的时候，devpos会自动触发相应的事件，自动调用api管理中心的API，触发生成自动生成API文档的功能；S4:api管理系统工作环节，当devops调用的API的时候，自动取拉取该系统的代码，进行相应的解析，保存到数据库中；S5:静态页面展示环节，需要查看相应的API文档时，登录api管理系统进行查看。2.根据权利要求1所述的一种基于互联网金融系统从源码生成系统交互的API文档的方法，其特征在于，在S1环节中包括以下步骤，步骤S11：代码开发人员或者系统负责人提交需要api管理系统的配置给api管理系统的系统管理员进行配置；步骤S12：api管理系统的系统管理员对系统/应用的相关信息进行配置，包括系统/应用的名称、代码仓库、负责人，配置的目的是为了后续自动生成API文档提供前置条件。3.根据权利要求1所述的一种基于互联网金融系统从...

【专利技术属性】
技术研发人员：钟成鹏，
申请(专利权)人：四川新网银行股份有限公司，
类型：发明
国别省市：