API服务管理
为了方便管理员管理API服务，系统提供了新增API服务、查看API服务详情、 API服务上线、 API服务下线、API服务测试、修改API服务和删除API服务功能。
新增API服务
在API分组中，添加API服务。点击API分组名称，进入API服务列表。
点击列表右上方的“新增”按钮，弹出新增API服务对话框。
在基本信息页签中，设置名称、API路径、请求方式、Content-Type、权限和描述信息。其中，请求方式的选项包括POST和GET。权限分为的选项包括开发和私有，通常情况下，选择私有选项，设置私有后，API服务需要授权后，才能上线。
设置完成后，选择SQL语句配置页签，如下图所示，开始配置API服务的SQL语句。
具体配置方法如下：
- 选择API服务数据来源，选项包括ZCBUS、发布端和订阅端。当选择发布- 端时，需要指定数据库类型和数据库；当选择发布端或订阅端时，需要指- 定订阅服务、数据库类型和数据库。
- 开启事务：根据需要对支持事务的数据库，选择是否开启事务。
- 查询最大行数：设置select语句查询返回的最大行数。
- 打开调试或关闭调试：当需要对填写SQL语句进行调试时，开启调试功能。
- SQL语句模板：为确保管理员高效完成SQL语句的填写，系统提供了trim、if、where和foreach语句模板。
- 格式化：完成SQL语句填写后，可使用该功能为SQL语句格式化。
- 查看详细说明：为了方便管理员查看SQL语法，系统通过了新增、删除、修改和查询SQL语句的详细语法说明。
- SQL语句内容：根据实际需要填写SQL语句。
- SQL参数设置：根据填写的SQL语句，设置用于调试的SQL参数。当打开调试功能时，需要设置SQL参数。
- 执行：当打开调试功能时，用于执行已填写SQL语句的调试。
- 执行结果：显示执行已填写SQL语句的调试结果，管理员可以根据调试结果，修改SQL语句。
- 请求参数：设置SQL语句运行所需的参数值，设置的参数格式与SQL语句中的参数个数需要保持一致。通过点击“添加一行”按钮，在表格中增加参数，然后在表格中填写参数名称以及其他信息。
- 响应结果：设置API服务返回值的条件。
设置完成后，选择脱敏配置页签，如下图所示，开始配置API服务的脱敏信息。
在列表中，填写脱敏字段，选择脱敏类型和规则类型后，即可完成一行脱敏配置。当需要再添加一行脱敏设置时，点击“添加一行”按钮，可在列表中添加一行。
完成上述配置后，点击“提交”按钮，即可完成API服务的新增。新增后的API服务将在API分组列表中显示，如下图。
查看API服务详情
管理员可以通过该功能查看指定API服务的详细配置信息。
在API分组的API服务列表中，点击API服务的操作列对应的“查看”链接，进入API服务详情页面。
API服务上线
对于开放的API服务，可直接上线；对于私有的API服务，需要先绑定API授权，才能上线。API服务上线后，才能开始投入使用。为私有API服务绑定API授权的方法，请参见API授权管理中的“为API服务绑定授权”章节。
在API分组的API服务列表中，点击API服务的操作列对应的“上线”链接，在弹出API服务上线确认对话框中，点击“确认”按钮，完成对API服务的上线。
API服务下线
对于已上线的API服务，可以执行下线操作。API服务下线后，不能再投入使用。
在API分组的API服务列表中，点击API服务的操作列对应的“下线”链接，在弹出API服务下线确认对话框中，点击“确认”按钮，完成对API服务的下线。
API服务测试
对于已上线的API服务，可以通过API服务测试来完成申请Token、生成请求头、校验JSON和确认响应结果等操作。测试完成后，管理员可以向需求方提供最终的使用命令。
不同类型的API服务，测试方法也不相同。本文以最常用的私有API服务为例，介绍API服务的测试方法，具体如下：
在API服务测试之前，需要先到API授权列表中，拷贝API授权的AppKey和AppSecret信息。
在API授权列表中，找到与待测试API服务绑定授权的名称，拷贝其对应的AppKey和AppSecret信息。
返回API分组页面，在目录中点击API分组名称，进入该分组的API服务列表页面。
点击待测试API服务的操作列对应的“测试”链接，进入API测试页面。
Token申请：使用在API授权列表中拷贝的AppKey和AppSecret，分别替换Token申请输入框已有描述中的xxx。例如：
/rest/api/token/generate?appKey=WjVvlk3AFWANpkmN&appSecret=xyk7f58505Jcox6B26WHJhYfQVpD9DkW。
替换完成后，点击“获取Token”按钮，系统会在“请求头”的apiToken字段中显示申请的Token。
在请求体（JSON）的对象{}中，根据实际情况填写参数名，填写完成后，点击下方的“校验json”按钮，然后点击URL中的“发送请求”按钮，进行API服务测试。在响应结果中，显示API服务的测试结果。
本例中，管理员在测试完成后，最终向需求方提供的使用命令如下：curl -X GET -H “apiToken: Zqkm2GYvhNLJ419jxWO0oCCDdrrEOK6g” -d ‘{“tabname”:”account_api”}’ http://192.168.2.31:8890/rest/api/bus_in_tables
修改API服务
管理员可以根据需要修改API服务的配置信息。
在API分组的API服务列表中，点击API服务的操作列对应的“修改”链接，进入修改API服务页面。
在修改API服务页面中，可以根据实际需要修改各项配置信息。修改完成后，点击“提交”按钮，完成对API服务配置的修改。
删除API服务
管理员可以删除API分组中的API服务。
在API分组的API服务列表中，勾选需要删除的API服务，点击“删除”按钮，在弹出删除API服务确认对话框中，点击“确认”按钮，完成对API服务的删除。
