MDClubAPI 文档

User:getList

仅管理员可使用 email 参数进行搜索。

仅管理员可获取已禁用的用户列表。

HTTP 请求

GET /api/users

参数

参数名参数位置类型默认值说明
pagequeryinteger1

当前页数

per_pagequeryinteger15

每页条数（最大为 100）

orderquerystring-create_time

排序方式。在字段前加 - 表示倒序排列。

可排序字段包括 create_time、disable_time、follower_count。默认为 -create_time。其中 disable_time 值仅管理员使用有效。

取值范围包括：create_time, disable_time, follower_count, -create_time, -disable_time, -follower_count

includequerystring

响应中需要包含的关联数据，用 , 分隔。可以为 is_followed, is_following, is_me

user_idqueryinteger

用户ID

usernamequerystring

用户名

emailquerystring

🔐邮箱

disabledquerybooleanfalse

🔐是否仅获取已禁用的用户

响应

用户列表

示例

{
  "code": 0,
  "data": [
    {
      "user_id": 1,
      "username": "zdhxiong",
      "email": "example@example.com",
      "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"
      },
      "cover": {
        "original": "https://mdclub.org/user-cover/c4/ca/bc03445db47540eea79148252e7a91fe.jpg",
        "small": "https://mdclub.org/user-cover/c4/ca/bc03445db47540eea79148252e7a91fe_small.jpg",
        "middle": "https://mdclub.org/user-cover/c4/ca/bc03445db47540eea79148252e7a91fe_middle.jpg",
        "large": "https://mdclub.org/user-cover/c4/ca/bc03445db47540eea79148252e7a91fe_large.jpg"
      },
      "create_ip": "210.23.121.44",
      "create_location": "中国 浙江 杭州",
      "last_login_time": 1563512214,
      "last_login_ip": "210.23.121.44",
      "last_login_location": "中国 浙江 杭州",
      "follower_count": 112,
      "followee_count": 8,
      "following_article_count": 12,
      "following_question_count": 14,
      "following_topic_count": 4,
      "article_count": 6,
      "question_count": 11,
      "answer_count": 28,
      "notification_unread": 4,
      "inbox_unread": 2,
      "headline": "mdui 作者",
      "bio": "独立全栈开发者",
      "blog": "https://mdui.org",
      "company": "无",
      "location": "杭州",
      "create_time": 1563512214,
      "update_time": 1563512214,
      "disable_time": 0,
      "relationships": {
        "is_me": false,
        "is_following": true,
        "is_followed": true
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 15,
    "previous": null,
    "next": 2,
    "total": 124,
    "pages": 9
  }
}

参数说明

参数名 类型 说明
code integer

无任何错误时，状态码为 0
data[].user_id integer

用户 ID
data[].username string

用户名
data[].email string

🔐邮箱
data[].avatar.original string

头像原图地址
data[].avatar.small string

小头像地址
data[].avatar.middle string

中头像地址
data[].avatar.large string

大头像地址
data[].cover.original string

封面原图地址
data[].cover.small string

小型封面地址
data[].cover.middle string

中型封面地址
data[].cover.large string

大型封面地址
data[].create_ip string

🔐注册 IP
data[].create_location string

🔐注册地
data[].last_login_time integer

🔐最后登陆时间
data[].last_login_ip string

🔐最后登陆 IP
data[].last_login_location string

🔐最后登录地
data[].follower_count integer

关注者数量
data[].followee_count integer

关注的用户数量
data[].following_article_count integer

关注的文章数量
data[].following_question_count integer

关注的提问数量
data[].following_topic_count integer

关注的话题数量
data[].article_count integer

发表的文章数量
data[].question_count integer

发表的提问数量
data[].answer_count integer

发表的提问回答数量
data[].notification_unread integer

🔐未读通知数量
data[].inbox_unread integer

🔐未读私信数量
data[].headline string

一句话介绍自己
data[].bio string

个人简介
data[].blog string

个人主页链接
data[].company string

所属企业
data[].location string

所在地区
data[].create_time integer

注册时间
data[].update_time integer

🔐更新时间
data[].disable_time integer

🔐禁用时间
data[].relationships.is_me boolean

该用户是否是当前登录用户
data[].relationships.is_following boolean

当前登录用户是否已关注该用户
data[].relationships.is_followed boolean

该用户是否已关注当前登录用户
pagination.page integer

当前页码
pagination.per_page integer

每页条数
pagination.previous integer

上一页页码，为 null 表示没有上一页
pagination.next integer

下一页页码，为 null 表示没有下一页
pagination.total integer

数据总数
pagination.pages integer

总页数