include前期主要用于加载主资源的关联资源

如日记资源需要需要关联用户资源示例如下


# http://mp.test/api/diaries/1  未加载关联资源时
{
  "data": {
    "audio": "http://omjq5ny0e.bkt.clouddn.com/suoxing.mp3",
    "category_id": 1,
    "content": "Sapiente illo porro molestias vero vel. Debitis consequatur facere autem modi sapiente. Et tempore exercitationem'
    "user_id": 8,
    "video": "http://omjq5ny0e.bkt.clouddn.com/test_video.mp4"
  }
}


# http://mp.test/api/diaries/1?include=user  加载关联资源时


{
  "data": {
    "audio": "http://omjq5ny0e.bkt.clouddn.com/suoxing.mp3",
    "category_id": 1,
    "content": "Sapiente illo porro molestias vero vel. Debitis consequatur facere autem modi sapiente. Et tempore exercitationem '
    "user": { # 可以看到user被嵌套了进来
      "data": {
        "avatar": "https://lorempixel.com/200/200/?27239",
        "id": 8,
        "nickname": "Delphia Feil"
      }
    },
    "user_id": 8,
    "video": "http://omjq5ny0e.bkt.clouddn.com/test_video.mp4"
  }
}

如一个资源需要关联过个资源, 使用英文逗号风格例
http://mp.test/api/diaries/1?include=user,is_like

关联资源筛选参数的使用

当需要被关联的资源进行筛选时,可以对关联资源添加参数

例 http://mp.test/categories/1?include=users:limit(5):fields(id|nickname|avatar):order(created_at|desc)
表示我们取出id为1的category时想要取出该资源下的关联的5个用户的基础信息,且这5位用户按照注册时间倒序

:参数名称(值1|值2|值N)这是一个参数的使用的基本示例

':' 冒号标志着一个参数的开始
紧跟着是参数名称
然后接上参数值其中参数的值需要被括号括起
多个参数值时使用 '|' 分隔
关联资源并不打算提供分页形式使用,因为其会造成冗余数据的重复读取, 如果需要取出的数据量很多, 需要分页则推荐将关联资源单独进行请求

关联资源嵌套资源使用

如果关联资源需要再次嵌套资源则使用

include在后期会开放一些计算属性已减少前端负担

http://mp.test/diaries/1?include=is_like,like_count 判断当前是否点赞了该日记, 具体可以include哪些参数请参考资源文档的 include字段

include前期主要用于加载主资源的关联资源

关联资源筛选参数的使用

关联资源嵌套资源使用

include在后期会开放一些计算属性 已减少前端负担

include在后期会开放一些计算属性已减少前端负担

通用参数 include使用详情