API是Application Programming Interface（應(yīng)用程序接口）的縮寫，它是拿來描述一個(gè)類庫的特征或是如何去運(yùn)用它。按照目前比較主流的分法，可以分為REST API和非REST API。知行之橋中的API端口主要支持對(duì)象就是REST API。

什么是REST API？

首先，REST是一種架構(gòu)風(fēng)格。REST API就是選擇通過使用http協(xié)議和uri，利用C/S（客戶端/服務(wù)器） 模型對(duì)資源進(jìn)行增刪改查操作。而其中客戶端和服務(wù)器是分離的，而知行之橋中的REST端口就是作為REST API中的客戶端，對(duì)服務(wù)器發(fā)起操作請(qǐng)求的。

如何使用REST端口？

1. 準(zhǔn)備工作

按照REST API的描述，需要確認(rèn)以下信息：

1.1 http協(xié)議
1.2 URI
1.3 方法
1.4 認(rèn)證
1.5 請(qǐng)求和響應(yīng)的數(shù)據(jù)格式

2. 配置

2.1 URL

2.2 方法

2.3 認(rèn)證

支持的認(rèn)證類型有None,Basic,NTLM,Digest,OAuth2,Bearer,AWSSignature等。

2.4 請(qǐng)求和響應(yīng)數(shù)據(jù)

3. 測試

本次將使用知行之橋的admin API作為示例，接口文檔可參考知行之橋頁面：api.rst 本次使用的接口目的是上傳文件到指定端口。

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

數(shù)據(jù)格式：JSON

Token認(rèn)證：

根據(jù)參數(shù)列表：

整理對(duì)應(yīng)的請(qǐng)求內(nèi)容：

將請(qǐng)求內(nèi)容保存成文件后，在REST端口的輸入頁面中上傳并發(fā)送：

將在端口Nina的輸入中生成一個(gè)文件：

常見問題：

1. 需要自動(dòng)使用GET方法獲取數(shù)據(jù)

在配置和調(diào)試完成后，在REST端口-》自動(dòng)化設(shè)置頁，勾選自動(dòng)化設(shè)置-》接收，并預(yù)設(shè)自動(dòng)輪詢時(shí)間即可。

2. 需要使用POST方法自動(dòng)獲取數(shù)據(jù)

需要在REST端口前加一個(gè)script端口，用于生成需要發(fā)送的請(qǐng)求數(shù)據(jù)，并勾選自動(dòng)化-》接收。Script端口的箭頭指向REST端口。

總結(jié)：

1.拿到REST API接口文檔；
2.按照接口文檔配置REST端口；
3.根據(jù)接口文檔中的屬性列表或測試文件整理請(qǐng)求數(shù)據(jù)；
4.發(fā)送請(qǐng)求數(shù)據(jù)，進(jìn)行調(diào)試。

審核編輯：符乾江