【技术实现步骤摘要】
本专利技术涉及api文档维护的，尤其是涉及一种自动化生成数据服务api接口文档的方法及装置。
技术介绍
1、随着大数据时代的推进，数据的价值和重要性已达到了前所未有的高度。数据不仅被视为一种宝贵的资产，同时也是企业生产要素之一，为企业的发展和竞争优势带来了巨大的潜力。在各种应用场景中，数据系统的开发过程从数据采集、数据处理到服务接口开发等环节都是不可或缺的。目前传统生成api文档的方案都通过代码注解的方式，在项目工程编译时期对代码进行扫描，并获得接口数据的元信息。根据接口数据生成接口文档并展示，便于开发人员调试接口。但是数据服务多为配置化，轻程序逻辑重sql逻辑，代码入口往往复用一份逻辑，导致传统的方法往往不能解析到相应代码元信息，往往需要人工维护相应的api文档。但是随着数据应用场景的日益丰富和开放的数据资产的不断增多，传统的人工维护数据服务api文档的方式已经无法满足企业的需求。因此，如何快速、自动地维护相关数据服务api文档已成为一个亟待解决的问题。
技术实现思路
1、本专利技术的目的就是为了实现快速自动地维护相关数据服务api文档而提供的一种自动化生成数据服务api接口文档的方法及装置。
2、本专利技术的目的可以通过以下技术方案来实现：
3、一种自动化生成数据服务api接口文档的方法，方法包括：
4、s1、构建图形化节点、数据节点和服务节点，然后获取api对应的api文档模板，将api文档模板录入图形化节点中，并保存在非易失性存储中，所述
5、s2、请求与api文档模板对应的服务节点，对服务节点的sql代码进行词法和语法分析，获取api文档模板的入参和出参字段；
6、s3、请求对应的数据节点，基于数据节点获取字段的元数据信息，基于元数据信息补充入参和出参字段的入参信息和出参信息，将补充完成的入参信息和出参信息存储到非易失性存储中的api文档模板中；
7、s4、进行api调试，得到请求示例和返回报文，将请求示例和返回报文存储到非易失性存储中的api文档模板中；
8、s5、将s4得到的非易失性存储中的api文档模板作为生成的api文档进行输出。
9、进一步地，对服务节点的sql代码进行词法和语法分析，获取api文档模板的入参和出参字段的具体步骤为：
10、对服务节点的sql代码中最外层的select语句的选取字段作为api文档模板的出参字段，对sql代码中带有#{}标识的字段作为入参字段。
11、进一步地，请求对应的数据节点的具体步骤为：
12、获取api文档模板的数据节点的地址，根据地址请求对应的数据节点。
13、进一步地，基于元数据信息补充入参和出参字段的入参信息和出参信息的具体步骤为：
14、基于元数据信息补充入参和出参字段的字段类型以及注释信息。
15、进一步地，进行api调试，得到请求示例和返回报文的具体步骤为：
16、设置可调试的图形化的页面，在页面中进行在线的api调试，得到请求示例和返回报文。
17、进一步地，所述请求示例和返回报文为api调试过程中最新测试成功的报文。
18、进一步地，api文档模板还包括基本信息。
19、进一步地，基本信息包括api路径、api协议、api创作者、api分类和api所属部门信息。
20、进一步地，非易失性存储为闪存或只读存储器。
21、本专利技术的另一方面，提出一种自动化生成数据服务api接口文档装置，包括api文档模板模块、代码解析模块、信息补充模块、调试模块和输出模块，其中，
22、api文档模板模块用于构建图形化节点、数据节点和服务节点，然后获取api对应的api文档模板，将api文档模板录入图形化节点中，并保存在非易失性存储中，所述api文档模板包括数据节点的地址、相应的sql文本以及待填充的入参信息、出参信息、请求示例和返回报文；
23、代码解析模块用于请求与api文档模板对应的服务节点，对服务节点的sql代码进行词法和语法分析，获取api文档模板的入参和出参字段；
24、信息补充模块用于请求对应的数据节点，基于数据节点获取字段的元数据信息，基于元数据信息补充入参和出参字段的入参信息和出参信息，将补充完成的入参信息和出参信息存储到非易失性存储中的api文档模板中；
25、调试模块用于进行api调试，得到请求示例和返回报文，将请求示例和返回报文存储到非易失性存储中的api文档模板中；
26、输出模块用于将调试模块得到的非易失性存储中的api文档模板作为生成的api文档进行输出。
27、与现有技术相比，本专利技术具有以下有益效果：
28、本专利技术设置数据节点和服务节点，服务节点保存业务逻辑sql代码，与文档模板一一对应的数据节点保存字段的元数据信息，可以解析到准确的与文档模板对应的元数据，显著提高生成api文档的效率和准确性。
本文档来自技高网...【技术保护点】
1.一种自动化生成数据服务API接口文档的方法，其特征在于，方法包括：
2.根据权利要求1所述的一种自动化生成数据服务API接口文档的方法，其特征在于，对服务节点的SQL代码进行词法和语法分析，获取API文档模板的入参和出参字段的具体步骤为：
3.根据权利要求1所述的一种自动化生成数据服务API接口文档的方法，其特征在于，请求对应的数据节点的具体步骤为：
4.根据权利要求1所述的一种自动化生成数据服务API接口文档的方法，其特征在于，基于元数据信息补充入参和出参字段的入参信息和出参信息的具体步骤为：
5.根据权利要求1所述的一种自动化生成数据服务API接口文档的方法，其特征在于，进行API调试，得到请求示例和返回报文的具体步骤为：
6.根据权利要求5所述的一种自动化生成数据服务API接口文档的方法，其特征在于，所述请求示例和返回报文为API调试过程中最新测试成功的报文。
7.根据权利要求1所述的一种自动化生成数据服务API接口文档的方法，其特征在于，API文档模板还包括基本信息。
8.根据权利要求
9.根据权利要求1所述的一种自动化生成数据服务API接口文档的方法，其特征在于，非易失性存储为闪存或只读存储器。
10.一种自动化生成数据服务API接口文档装置，其特征在于，包括API文档模板模块、代码解析模块、信息补充模块、调试模块和输出模块，其中，
...【技术特征摘要】
1.一种自动化生成数据服务api接口文档的方法，其特征在于，方法包括：
2.根据权利要求1所述的一种自动化生成数据服务api接口文档的方法，其特征在于，对服务节点的sql代码进行词法和语法分析，获取api文档模板的入参和出参字段的具体步骤为：
3.根据权利要求1所述的一种自动化生成数据服务api接口文档的方法，其特征在于，请求对应的数据节点的具体步骤为：
4.根据权利要求1所述的一种自动化生成数据服务api接口文档的方法，其特征在于，基于元数据信息补充入参和出参字段的入参信息和出参信息的具体步骤为：
5.根据权利要求1所述的一种自动化生成数据服务api接口文档的方法，其特征在于，进行api调试，得到请求示例和返回报文的具体步骤为：
6.根据权...
【专利技术属性】
技术研发人员：朱海欢，孙谷飞，王智林，同乐，黄彪，李佩佩，
申请(专利权)人：中国太平洋人寿保险股份有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。