数据接口管理系统操作手册

 

 

 

 

 

 

技术支持

坦克之荣

产品版本

V1.0

发布日期

2023-3-28

 

 

 

 

 

单击或点击此处输入文本。

 

 

目录

简介... 3

产品/服务/方法... 4

系统功能... 8

升级规划... 13

 

 

简介

 

数据接口管理系统是一款Python+Oracle数据库开发的用于管理oracle数据库调用第三方api的前端管理软件，设计之初本着一切皆可配置的设计思路，系统加入了多个配置文件。

软件为绿色版，无需安装oracle客户端，无需安装本软件，解压即用，无路径要求限制。

通过本软件可实现oracle数据库的用户创建，用户授权，脚本更新，job任务管理（新建、删除、启动、停止），接口数据日志监控，接口调试等相关功能，本软件也可提供定制化功能开发。

 

 

系统初始化

首次运行软件，需要根据oracle服务器进行初始化连接配置，如果不做初始化，也可以用来做一个接口测试工具，但数据库相关管理功能将无法使用。

初始化详细步骤如下，

第一步∶输入账号密码（默认账号为admin密码为databox）不选择配置直接点击登录即可登录系统主界面，如下图显示

图一：登录界面

图二：系统主界面

第二步∶点击菜单中的工具菜单，选择系统初始化，弹出初始化窗口，根据窗口下面的提示信息完成相关内容的录入，然后点击创建，系统会自动在指定实例下创建一个新用户，并切换至授权页面，如下图所示

图三：初始化界面

第三步∶授权页面根据需要勾选相应的权限，本界面需要有对oracle有一定认识基础的人操作，见下图

图四：授权选择

第四步∶授权勾选完成后点击下一步进入补丁更新页面，根据自己写的接口相关脚本导入依赖和接口执行脚本，如下图所示

图五：补丁更新

第五步：在导入脚本过程中可能会出现失效对象，点击下一步进入对象检查页面，选择对应的失效对象，即可看到导致对象失效的列表信息。，打开对应脚本，修改错误地方或联系脚本提供人员进行修改，修改后可通过脚本更新功能进行更新，如下图所示

图六：失效对象检查

 

至此，系统初始化完成。

初始化完成后退出系统重新登陆，在登录界面的配置里面选择自己新建的实例配置，如下图

图七：选择配置登录

选择实例配置时需要注意配置下面的提示，如果为绿色字体提示配置成功，说明初始化没有漏项，如果为黄色字体提示配置加载成功但缺少相应的表，说明初始化的时候漏掉了基本配置的相关表脚本更新，如果为红色字体提示，需要根据提示内容分析原因，配置没有问题的情况点击登录即可进入主界面

 

 

系统功能

在主界面可以进行以下操作

1．主任务——接口配置

用于新增接口或修改原接口信息

如下图：

图八：接口配置

2．主任务——参数配置

配置系统参数表，控制接口的控制参数

如下图：

图九：参数配置

3．工具——脚本更新

用于日常功能开发后的脚本更新和失效对象检查

图十：脚本更新

4．主界面——任务监控

用于新job任务的创建，启停，删除等功能操作，通过右键菜单进行相应菜单选择

图十一：任务监控

5．主界面——日志查询

指定日期查询数据接口发送数据情况，对于异常数据可以右键复制数据到接口测试功能处进行数据发送测试

图十二：日志监控

6．主界面——接口调试

1)用于对新接口和老接口的测试，地址栏可以输入接口地址，如果配置了数据连接和接口，该处也可直接选择对应的接口地址进行测试

图十三：接口调试

2)接口分为get和post

图十四：GET接口调试

 

图十五：POST接口调试

3)可选择是前端直接测试，也可选择直接调用数据库端的单条记录测试

4)可动态配置用户id和密钥还有Token值

 

 

 

 

 

升级规划

 

1．增加服务功能，实现接受发送数据双任务功能

2．逐步替代oracle的计划任务，改由服务实现

3．利用python的爬虫功能实现知识库功能

4．增加B端接口管理界面