展开查询
展开查询用于在一次请求中查询返回某实体的记录以及关联实体的记录。
请求参数:
参数 | 类型 | 必须 | 作用 |
---|---|---|---|
expand | string | 否 | 需要展开的关系名,多个以逗号, 分割 |
示例
用户和组织对象之间存在多对一双向关系,如下面的swagger定义:
User
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
},
"name": {
"type": "string",
},
"org": {
"$ref": "#/definitions/Org"
}
}
}
Org
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
},
"name": {
"type": "string",
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/User"
}
}
}
}
从用户展开查询组织
请求 GET /user/1?expand=org
,返回:
{
"id": 1,
"name": "user1",
"org": {
"id": 10,
"name": "org1"
}
}
从组织展开查询用户
请求 GET /org/10?expand=users
,返回:
{
"id": 10,
"name": "org1",
"users": [
{
"id": 1,
"name": "user1"
},
{
"id": 2,
"name": "user2"
}
]
}