menu MDClub API 文档

Image:getList

注意:该接口需要管理员权限才能调用。

获取图片列表。

HTTP 请求

GET /api/images

参数

参数名 参数位置 类型 默认值 说明
page query integer 1

当前页数

per_page query integer 15

每页条数(最大为 100)

include query string

响应中需要包含的关联数据,用“,”分隔。可以为 user, question, article, answer

key query string

图片key

item_type query string

图片关联对象的类型

取值范围包括:question, answer, article

item_id query integer

图片关联对象的ID

user_id query integer

用户ID

响应

图片列表

示例

{
  "code": 0,
  "data": [
    {
      "key": "4c018974e3cf4e1d8c174d82adba0c43.jpg",
      "filename": "Material Design Logo.png",
      "width": 1280,
      "height": 720,
      "create_time": 1563512214,
      "item_type": "question",
      "item_id": 1,
      "user_id": 1,
      "urls": {
        "original": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe.jpg",
        "release": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe.jpg",
        "thumb": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe.jpg"
      },
      "relationships": {
        "user": {
          "user_id": 1,
          "username": "zdhxiong",
          "headline": "mdui作者",
          "avatar": {
            "original": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe.jpg",
            "small": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_small.jpg",
            "middle": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_middle.jpg",
            "large": "https://mdclub.org/user-avatar/c4/ca/bc03445db47540eea79148252e7a91fe_large.jpg"
          }
        },
        "question": {
          "question_id": 1,
          "title": "请问作者开发了哪些软件?",
          "create_time": 1563512214,
          "update_time": 1563512214
        },
        "article": {
          "article_id": 1,
          "title": "欢迎使用 MDClub 开源社区系统",
          "create_time": 1563512214,
          "update_time": 1563512214
        },
        "answer": {
          "answer_id": 1,
          "question_id": 1,
          "content_summary": "mdui 是目前最具有逻辑性、一致性、简洁性、高可用、且对规范实现的最好的 Material Design 框架。",
          "create_time": 1563512214,
          "update_time": 1563512214
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 15,
    "previous": null,
    "next": 2,
    "total": 124,
    "pages": 9
  }
}

参数说明

参数名 类型 说明
code integer

无任何错误时,状态码为 0

data[].key string

图片的 key

data[].filename string

图片原始文件名

data[].width integer

原始图片宽度

data[].height integer

原始图片高度

data[].create_time integer

图片上传时间

data[].item_type string

图片关联对象类型

取值范围包括:question, answer, article

data[].item_id integer

图片关联对象ID

data[].user_id integer

图片上传者ID

data[].urls.original string

原图地址

data[].urls.release string

宽度固定,高度自适应的图片地址

data[].urls.thumb string

固定宽高的缩略图地址

data[].relationships.user.user_id integer

用户ID

data[].relationships.user.username string

用户名

data[].relationships.user.headline string

一句话介绍

data[].relationships.user.avatar.original string

头像原图地址

data[].relationships.user.avatar.small string

小头像地址

data[].relationships.user.avatar.middle string

中头像地址

data[].relationships.user.avatar.large string

大头像地址

data[].relationships.question.question_id integer

提问ID

data[].relationships.question.title string

提问标题

data[].relationships.question.create_time integer

发布时间

data[].relationships.question.update_time integer

更新时间

data[].relationships.article.article_id integer

文章ID

data[].relationships.article.title string

文章标题

data[].relationships.article.create_time integer

发布时间

data[].relationships.article.update_time integer

更新时间

data[].relationships.answer.answer_id integer

回答ID

data[].relationships.answer.question_id integer

提问ID

data[].relationships.answer.content_summary string

内容摘要

data[].relationships.answer.create_time integer

发布时间

data[].relationships.answer.update_time integer

更新时间

pagination.page integer

当前页码

pagination.per_page integer

每页条数

pagination.previous integer

上一页页码,为 null 表示没有上一页

pagination.next integer

下一页页码,为 null 表示没有下一页

pagination.total integer

数据总数

pagination.pages integer

总页数