在BMC开发中经常使用Postman工具测试Restful/Redfish接口,简单记录一下Postman工具的使用方法。
测试Restful接口需要URL与操作方法两部分信息。常用的有POST,PUT,GET与DELETE等。
POST:常用于创建新的信息
PUT:用于修改已有信息
GET:用于获取信息
DELETE:用于删除信息
使用Postman工具进行测试的步骤如下:
- 启动Postman,如下图所示。
- 新建session。首先根据BMC提供的Restful接口建立Session,通过建立的Session进行后续其他URL的测试。比如通过POST https://BMC_IP/api/session创建session,获取CSRFToken与Cookies。选择方法为POST,设置其他参数如下图所示:
Params参数配置:
Authorization参数配置:
Headers参数配置:
添加两个key:
X-Requested-With,XMLHttpRequest
Content-Type,application/x-www-form-urlencoded
Body参数配置:添加BMC的用户名和密码
参数配置完成后,点击send发送请求,如发送成功,返回如下,记录返回提中的CSRFToken值;
从返回Headers中获取Cookies:
3.开始测试URL。新建需要测试的restful接口请求,填写正确的url,选择正确的方法,如下图所示:
(1)Post方法:
需要设置Headers参数
添加以下key值
X-CSRFTOKEN:填入创建Ssession获取到的CSRFTOKEN;
Cookie:填入创建Session获取到的Cookie
Content-Type:填入application/json
设置Headers参数后,根据不同url的需求填入不同的请求体,如下图所示:
以上填写完毕,点击Send,即完成POST请求发送,可等待查看返回值。
(2)GET请求:
填入所请求的URL,Headers参数设置同上,请求体为none点击send后,获取到的信息显示在body中,如下图所示:
测试Redfish接口的方法也与以上类似,建立Session的部分略有差别。根据BMC提供的 URL,发送POST请求建立Session。
如URL为https://BMC_IP/redfish/v1/SessionService/Sessions。Body选择raw,并在右侧下拉选项中选择JSON,根据BMC用户名密码填写UserName与Password字段:
{
“UserName”:“xxxx”,
“Password”:“xxxxx”
}
点击Send,在返回体中复制Headers/X-Auth-Token的内容,用于其他url的使用,如下所示:
测试Get方法的URL时,如上图,填入url后选择Get方法,在Headers选项栏KEY选项中填入X-Auth-Token,对应的VALUE中填入复制的X-Auth-Token的值,点击Send,如下图所示: