menu MDClub API 文档

Topic:getList

获取全部话题。

HTTP 请求

GET /api/topics

参数

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

当前页数

per_page query integer 15

每页条数(最大为 100)

include query string

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

order query string topic_id

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

可排序字段包括 topic_idfollower_countdelete_time。默认为 topic_id。其中 delete_time 值仅管理员使用有效。

取值范围包括:topic_id, follower_count, delete_time, -topic_id, -follower_count, -delete_time

topic_id query integer

话题ID

name query string

话题名称

trashed query boolean

🔐是否仅获取回收站中的数据

响应

话题列表

示例

{
  "code": 0,
  "data": [
    {
      "topic_id": 1,
      "name": "MDClub",
      "cover": {
        "original": "https://mdclub.org/topic-cover/c4/ca/bc03445db47540eea79148252e7a91fe.jpg",
        "small": "https://mdclub.org/topic-cover/c4/ca/bc03445db47540eea79148252e7a91fe_small.jpg",
        "middle": "https://mdclub.org/topic-cover/c4/ca/bc03445db47540eea79148252e7a91fe_middle.jpg",
        "large": "https://mdclub.org/topic-cover/c4/ca/bc03445db47540eea79148252e7a91fe_large.jpg"
      },
      "description": "一个漂亮强大的开源社区系统",
      "article_count": 12,
      "question_count": 16,
      "follower_count": 42,
      "delete_time": 0,
      "relationships": {
        "is_following": true
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 15,
    "previous": null,
    "next": 2,
    "total": 124,
    "pages": 9
  }
}

参数说明

参数名 类型 说明
code integer

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

data[].topic_id integer

话题ID

data[].name string

话题名称

data[].cover.original string

封面原图地址

data[].cover.small string

小型封面地址

data[].cover.middle string

中型封面地址

data[].cover.large string

大型封面地址

data[].description string

话题描述

data[].article_count integer

文章数量

data[].question_count integer

提问数量

data[].follower_count integer

关注者数量

data[].delete_time integer

🔐删除时间

data[].relationships.is_following boolean

当前登录用户是否已关注该话题

pagination.page integer

当前页码

pagination.per_page integer

每页条数

pagination.previous integer

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

pagination.next integer

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

pagination.total integer

数据总数

pagination.pages integer

总页数