REST API是什么，如何使用REST端口

API是Application Programming Interface（应用程序接口）的缩写，它是拿来描述一个类库的特征或是如何去运用它。按照目前比较主流的分法，可以分为REST API和非REST API。知行之桥中的API端口主要支持对象就是REST API。

什么是REST API？

首先，REST是一种架构风格。REST API就是选择通过使用http协议和uri，利用C/S（客户端/服务器） 模型对资源进行增删改查操作。而其中客户端和服务器是分离的，而知行之桥中的REST端口就是作为REST API中的客户端，对服务器发起操作请求的。

如何使用REST端口？

1. 准备工作

按照REST API的描述，需要确认以下信息：

1.1 http协议
1.2 URI
1.3 方法
1.4 认证
1.5 请求和响应的数据格式

2. 配置

2.1 URL

2.2 方法

2.3 认证

支持的认证类型有None,Basic,NTLM,Digest,OAuth2,Bearer,AWSSignature等。

2.4 请求和响应数据

3. 测试

本次将使用知行之桥的admin API作为示例，接口文档可参考知行之桥页面：api.rst 本次使用的接口目的是上传文件到指定端口。

接口URL： http://localhost:8014/api.rsc/files/ 操作：POST

数据格式：JSON

Token认证：

根据参数列表：

整理对应的请求内容：

1   2   3   4   5   6   7

{ "ConnectorId": "Nina", "Folder": "Send", "Filename": "test.txt", "MessageId": "MessageId_1", "Content": "VGhpcyBpcyBhIHRlc3QgZmlsZQ==" }

将请求内容保存成文件后，在REST端口的输入页面中上传并发送：

将在端口Nina的输入中生成一个文件：

常见问题：

1. 需要自动使用GET方法获取数据

在配置和调试完成后，在REST端口-》自动化设置页，勾选自动化设置-》接收，并预设自动轮询时间即可。

2. 需要使用POST方法自动获取数据

需要在REST端口前加一个script端口，用于生成需要发送的请求数据，并勾选自动化-》接收。Script端口的箭头指向REST端口。

总结：

1.拿到REST API接口文档；
2.按照接口文档配置REST端口；
3.根据接口文档中的属性列表或测试文件整理请求数据；
4.发送请求数据，进行调试。

审核编辑：符乾江