Appearance
外部集成
GRG低代码开发平台支持通过配置SQL无代码快速的实现API的发布。相比于传统API开发模式具有更轻量级、更快速、更低代码量、更易于学习等特点。平台支持多数据源、可以实现一对多、多对多、多对一的查询、持久化、删除等操作的API发布。使用本平台普通工程师通过浏览器即可快速实现API的开发和发布，API开发效率提升80%以上。
1. API接口定义
- 功能说明
通过本功能可定义AIP接口。
- 导航菜单
开发平台>>AIP管理>>API接口工具
- 使用说明
可配置查询、新增、修改和删除等各类AIP接口。
- 新增API接口：点击新增，填写接口名称、访问地址、数据源和相应执行的SQL等信息，并进行保存，如下图所示：
(1) 项目名称：用于区分接口归属
(2) Api类型：包括认证API、查询单条结果API、查询多条结果API、修改单条数据API、修改多条数据API、新增单条数据API、新增多条数据API、删除单条数据API、删除多条数据API，对于查询列表接口，选择查询多条结果API
(3) 接口名称：定义一个方便区分的接口名称
(4) 访问地址：这里填写接口访问的相对路径，发布后通过接口访问路径为：http://IP:端口/openapi/[访问地址]
(5) 数据源：填写接口SQL查询的数据源
(6) 操作SQL或Class：填写执行SQL或自己定义业务类，业务类格式为：[类路全名]:[方法名]
(7) 执行前判断SQL：可编写执行校验SQL
(8) 执行前判断SQL异常反馈：定义执行前判断SQL校验失败时，返回的错误信息
(9) 执行后更新SQL：当接口执行后需要触发其他数据修改时，可定义相应的执行SQL
点击api参数明细Tab，可定义接口传入参数，如下图所示：
(1) 参数来源：包括参数传入、tocken获得、默认值，参数传入即为调用方传入，tocken获得系统将根据登录用户的tocken进行获取，默认值即，设置一个常量
(2) 参数代号：接口传入参数名
(3) 参数名称：参数中文描述
(4) 参数类型：包括文本、日期、数据、List数组、Map对象，List数组和Map对象均用Json格式处理
(5) 必填：如设置为必填，系统自动校验，参数不能为空
(6) 格式校验正则表达式：如需进行格式校验，写好相应的校验正则表达式，即可
(7) 转换方式：支持将传入数据，进行转换，包括：数据字典text-value的转换、数据字典value-text的转换，或部门名称和id的互相转换
(8) 转换控件值：如转换方式为数据字典的，必须设置使用的字典控件名称
(9) 默认值：参数的默认值
点击api返回值明细Tab，可定义接口返回参数，如下图所示：
(1) 字段代号：返回的字段名
(2) 字段名称：返回字段中文描述
(3) 字段类型：包括文本、日期、数据、List数组、Map对象，List数组和Map对象均用Json格式处理
(4) Null转默认值：如查询结果为null，自动转换的默认值
(5) 转换方式：支持将查询结果数据进行转换，包括：数据字典text-value的转换、数据字典value-text的转换，或部门名称和id的互相转换
(6) 转换控件值：如转换方式为数据字典的，必须设置使用的字典控件名称
(7) 样式转换：将查询结果自动进行格式转换，包括：转成日期格式、转成时间格式或使用正则表达式进行转换
(8) 样式转换正则表达式：样式转换为正则表达式时，填写相应的表达式
(9) 子接口API：系统支持接口嵌套，如查询一个订单，包括主单据和订单明细，那么可将订单明细定义一个接口，在定义订单主接口时，通过选择字段类型为List数组，并在子接口API信息中选择引用相应的订单明细接口
完成设置后，返回API接口列表界面，选择要发布的接口点击生效，可完成接口发布。
2. API黑名单IP
- 功能说明
GRG低代码平台可对某个接口API通过ip地址限制访问。
- 导航菜单
开发平台>>AIP管理>>API接口工具
使用说明
新增黑名单IP：选择一个要限制的接口记录，点击api黑名单IP明细Tab，可填写接口要屏蔽的ip，被屏蔽的ip无法访问此接口，如下图所示：
3. API接口授权
- 功能说明
GRG低代码平台可对定义的API接口分配用户，进行接口授权。
- 导航菜单
开发平台>>AIP管理>>API访问用户管理
- 使用说明
添加接口访问用户，并进行接口授权，如下图所示：
点击用户权限明细Tab，并点击导入可导入设置该用户可访问的接口，并可限制接口的访问次数，如下图所示：
4. API接口测试
- 功能说明
GRG低代码平台支持对定义的接口进行简单的在线测试。
- 导航菜单
开发平台>>AIP管理>>API接口工具
- 使用说明
打开API接口工具，点击rest测试工具Tab，输入接口地址和消息json，可对接口进行测试，如下图所示：
5. API接口文档
- 功能说明
GRG低代码平台支持对定义的接口自动导出生成接口文档。
- 导航菜单
打开开发平台>>AIP管理>>API接口工具
- 使用说明
打开API接口工具，点击导出离线文档，系统自动打包生成接口文档，如下图所示：
6. API访问日志
- 功能说明
GRG低代码平台对访问的接口进行监测，并记录日志，可通过系统查询接口的访问日志。
- 导航菜单
开发平台>>AIP管理>>API访问日志
- 使用说明
打开API访问日志功能，可查看API的访问日志，如下图所示：
