路由导航http接口规范
1. http节点配置
例如配置了下图的http节点:
配置的请求地址为:
http://example.com/test
, 请求时原始的请求参数为:
{
"id": "123",
"sid": "xxxxxxxx",
"thirdId": "xxx"
}
根据不同的请求方法,具体时机请求有两种:
GET请求
会将原始请求参数拼接到请求url后面,参数会被编码, 上边的请求实际请求如下:
curl --location --request GET 'http://example.com/test?id=123&sid=xxxxx&thirdId=xxx'
POST请求
会将原始请求参数作为请求体, 新增两个请求头然后请求接口, 实际请求如下:
curl --location --request POST 'http://example.com/test' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"id":"123","sid":"xxxxxxxxxx","thirdId":"xxx"}'
响应结果
加上上边接口无论是GET还是POST请求, 最终都会返回一个json格式的结果, httpCode码为200且返回的json数据中,第一层的code需要为数字或字符串0,方表示请求成功,例如:
{
"code": 0,
"message": "ok",
"data": {
"name": "张三",
"age": "18",
"orders": [
{
"order_name": "苹果",
"status": 1
},
{
"order_name": "香蕉",
"status": 1
}
],
"user": {
"name": "aa",
"age": 30
}
}
}
请求完毕后, 根据配置的请求结果中包含的变量
, 将返回的结果从第一层的data中提取出来,放到节点的变量里边,
例如上边配置的name,age
, 会将
{
"name": "张三",
"age": "18"
}
变量结果存储到node2这个节点的变量中, 其他节点可以直接引用这个变量.