一种全周期可视化的数据服务开发平台及方法与流程

本发明属于数据服务平台领域，涉及接口管理技术，具体是一种全周期可视化的数据服务开发平台及方法。

背景技术：

1、目前大部分接口开发的工作依旧是通过研发人员通过编写代码完成，同时随着低代码平台的发展，接口开发工作也开始可以通过一些接口开发平台完成，通过这些接口开发平台，能够帮助企业实现降本增效目标，同时也实现了企业快速开发，快速交付的目标。市场上大部分接口快速开发平台都基于数据库对象或者对象建模驱动，通过对象建模很好的实现接口和底层数据库，数据库表之间的解耦，也方便实现底层多数据库，多表的支持能力，开发并且发布类似crud的接口服务；

2、但市场上的很多接口工具很难做到真正的开发管理一站式管理，在接口开发能力上并没有做到轻量级敏捷开发，结合实际的应用场景很难落地。并且通过各种工具进行接口管理工作依旧困难重重，维护不同工具之间数据一致性非常困难、低效。并且这里不仅仅是工作量的问题，更大的问题是多个系统之间数据不一致，导致协作低效、频繁出现问题，开发测试人员痛苦不堪；

3、为此，提出一种全周期可视化的数据服务开发平台及方法。

技术实现思路

1、本发明旨在至少解决现有技术中存在的技术问题之一。为此，本发明提出一种全周期可视化的数据服务开发平台及方法，该一种全周期可视化的数据服务开发平台及方法通过设置数据源适配模块为开发平台适配各类数据源平台，并进行数据源配置接入；设置信息录入模块为平台创建crdu接口，配置接口的基本信息；设置接口调试模块对平台上每个配置的接口的功能进行调试；设置用户在使用人工自定义开发的接口接入平台前，先通过接口注册模块将接口进注册；设置接口授权模块为接入开发平台的接口设置接入权限；设置文档生成模块在接口被授权后，为接入平台的接口生成共享文档；同时，接口测试模块为开发者在接口授权完成后，对接口进行测试；解决了数据接口统一化的问题。

2、为实现上述目的，根据本发明的第一方面的实施例提出一种全周期可视化的数据服务开发平台，包括数据源适配模块、信息录入模块、接口调试模块、接口注册模块、接口授权模块、文档生成模块以及接口测试模块；其中，各个模块之间通过电气方式连接；

3、其中，所述数据源适配模块主要用于为开发平台适配各类数据源平台，并进行数据源配置接入；

4、所述数据源适配模块适配的数据源平台包括在实际开发过程中使用的关系型数据库；包括但不限于mysql、oracle、sql server以及postgresql等；所述数据源适配模块对数据源进行配置后，通过信息录入模块为数据源录入接口的基本信息；

5、其中，所述信息录入模块主要用于创建crdu接口，配置接口的基本信息；

6、所述接口的基本信息包括但不限于服务器名称、所述模块、开发状态、接口类型以及服务描述等信息；所述信息录入模块提供向导模式配置以及脚本模式进行配置；对于不同类型的接口，继续配置接口的基础信息；具体的，配置不同接口的基础信息包括以下方式：

7、接口类型为查询接口时，则配置返回信息以及查询条件；所述返回信息包括返回参数名称、返回参数描述、映射字段以及返回格式；所述查询条件包括请求参数、固定条件以及分页信息；其中，所述返回格式支持数据格式化及数据脱敏等处理方式；其中，所述请求参数为调用该请求接口时进行传参的信息；

8、接口类型为修改接口时，则配置修改条件及修改信息；其中，所述修改条件包括请求参数和固定条件；其中，所述修改信息包括请求参数和固定参数；请求参数为调用该请求接口时进行传参的信息；

9、接口类型为删除接口时，则配置删除条件；所述删除条件包括请求参数以及固定条件；请求参数为调用该请求接口时进行传参的信息；

10、接口类型为添加接口时，则配置添加信息；所述添加信息包括参数名称、映射字段及参数说明；请求参数为调用该请求接口时进行传参的信息；

11、信息录入模块将待录入信息进行配置后，通过接口调试模块对接口功能进行调试；

12、其中，所述接口调试模块主要用于对每个接口的功能进行调试；

13、所述接口调试模块对接口功能进行调试的方式为：根据每个接口的实际功能，根据实际经验为每个接口提供对应的测试样例；并根据实际经验判断测试样例的结果是否符合预期；若不符合预期，则进行重新调试，直至所有样例均通过测试为止；

14、经过接口调试模块对测试案例的调试后，通过接口注册模块进行接口的接入；

15、其中，所述接口注册模块主要用于用户在使用人工自定义开发的接口接入平台前，先将接口进注册；

16、所述接口注册模块将接口进行注册包括以下方式：

17、方式一：采用可视化的接口注册方式；具体的，包括以下步骤：

18、步骤s1：录入接口信息(包含接口名称、接口地址、接口描述、请求参数、请求头等信息)；

19、步骤s2：接口调试成功即可完成注册，并进行授权调用；

20、方式二：采用自动扫描注册方式进行注册；具体的，包括以下步骤：

21、步骤p1：将接口自动扫描注册服务封装为jar包；

22、步骤p2：将jar包作为依赖添加至开发项目；

23、步骤p3：修改配置文件，开启扫描并请求扫描路径，将会自动拦截平台请求调用信息并进行解析，自动完成接口信息注册及更新；

24、步骤p4：通过第一种技术方案提供的可视化界面即可查看扫描注册的接口信息；

25、开发者经过接口注册接入开发平台后，通过接口授权模块进行接入权限设置；

26、其中，所述接口授权模块主要用于为接入开发平台的接口设置接入权限；

27、所述接口授权模块为接口设置接入权限包括以下方式：

28、方式一：完全公开方式；具体的，包括以下步骤：

29、步骤x1：平台默认提供完全授权角色；

30、步骤x2：添加需要完全公开授权的接口至完全授权角色；

31、步骤x3：被授权方即可根据提供的接口信息进行调用；

32、方式二：固定令牌方式；具体的，包括以下步骤：

33、步骤y1：添加固定令牌授权角色，并且随机生成一个固定令牌；

34、步骤y2：添加需要授权的接口至固定令牌授权角色；

35、步骤y3：被授权方即可根据提供的接口信息进行调用并传入令牌信息，令牌信息与固定令牌信息进行一致性比对，比对通过后则返回数据；

36、方式三：动态令牌方式；具体的，包括以下步骤：

37、步骤z1：添加动态令牌授权角色，并且生成令牌获取地址，并且设置账号、密码及令牌刷新时间；所述令牌刷新时间周期可以是每日、每周或每月；

38、步骤z2：添加需要授权的接口至动态令牌授权角色；

39、步骤z3：被授权方根据令牌获取地址、账号、密码信息获取当前动态令牌；

40、步骤z4：被授权方即可根据提供的接口信息进行调用并传入令牌信息，令牌信息与当前的动态令牌信息进行一致性比对，比对通过后则返回数据；

41、方式四：第三方授权方式；具体的，包括以下步骤：

42、步骤w1：添加第三方授权角色，并且生成令牌共享地址；

43、步骤w2：添加需要授权的接口至第三方授权角色；

44、步骤w3：根据令牌共享地址将令牌共享至本平台；

45、步骤w4：被授权方即可根据提供的接口信息进行调用并传入令牌信息，令牌信息与共享的令牌信息进行一致性比对，比对通过后则返回数据；

46、在接口授权模块对接口进行接入权限设置后，通过文档生成模块生产共享文档，以及通过接口测试模块对接入的接口进行功能测试；

47、其中，所述文档生成模块主要用于在接口被授权后，为接入平台的接口生成共享文档；

48、所述文档生成模块生成共享文档包括以下步骤：

49、步骤r1：对于开发或者注册的接口，设置接口请求参数及响应数据说明；

50、步骤r2：创建分享文档，并通过全应用、模块、被授权方或自定义方式添加接口；

51、步骤r3：设置分享时间及加密方式，并生成在线文档分享地址；

52、其中，所述接口测试模块主要用于开发者在接口注册完成后，对接口进行测试；

53、所述接口测试模块对接口进行测试包括以下步骤：

54、步骤q1：对于开发或者注册的接口，根据实际经验设置接口测试参数；

55、步骤q2：创建测试流程并且添加需要进行测试的接口，根据实际经验设置接口执行顺序；

56、步骤q3：对测试流程全局变量进行配置，将接口响应数据存至变量，供下一步执行的接口取用并设为请求参数；

57、步骤q4：对执行过的流程测试信息进行记录。

58、根据本发明的第二方面的实施例提出一种全周期可视化的数据服务开发方法，包括以下步骤：

59、步骤一：数据源适配模块为开发平台适配各类数据源平台，并进行数据源配置接入；

60、步骤二：信息录入模块为平台创建crdu接口，配置接口的基本信息；

61、步骤三：接口调试模块对平台上每个配置的接口的功能进行调试；

62、步骤四：用户在使用人工自定义开发的接口接入平台前，先通过接口注册模块将接口进注册；

63、步骤五：接口授权模块为接入开发平台的接口设置接入权限；

64、步骤六：文档生成模块在接口被授权后，为接入平台的接口生成共享文档；同时，接口测试模块为开发者在接口授权完成后，对接口进行测试。

65、与现有技术相比，本发明的有益效果是：

66、本发明解决了传统模式下接口开发学习成本高，效率低下的难题，通过可视化界面配置的方式即可快速完成接口开发工作，具有更轻量级、更快速、更全面、更低代码量、更易于学习等特点。同时整合了可视化接口开发、自定义接口注册、自动化测试、分享文档生成、接口授权等全周期管理能力，解决了多工具之间重复配置、协作低下、数据不一致等难题。