ArticleApi.getList

获取文章列表。

方法定义

ArticleApi.getList(param: GetListParams): Promise<ArticlesResponse>

参数

GetListParams ArticleApi.ts:163

参数名 必选 类型 说明
article_id number

文章ID

include string

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

order string

排序方式。在字段前加 - 表示倒序排列。 可排序字段包括 vote_countcreate_timeupdate_timedelete_time。默认为 -create_time。其中 delete_time 值仅管理员使用有效。

取值范围包括:vote_countcreate_timeupdate_timedelete_time-vote_count-create_time-update_time-delete_time

page number

当前页数,默认为 1

per_page number

每页条数,默认为 15(最大为 100)

topic_id number

话题ID

trashed boolean

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

user_id number

用户ID

响应

ArticlesResponse models.ts:257

参数名 类型 说明
code number

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

data Article[]
pagination Pagination

Article models.ts:118

参数名 类型 说明
article_id number

文章ID

comment_count number

评论数量

content_markdown string

Markdown 格式的文章内容

content_rendered string

HTML 格式的文章内容

create_time number

创建时间

delete_time number

🔐删除时间

follower_count number

关注者数量

relationships ArticleRelationship
title string

文章标题

update_time number

更新时间(用户可以更新自己的文章)

user_id number

用户ID

vote_count number

投票数(赞成票 - 反对票,可能为负数)

vote_down_count number

反对票总数

vote_up_count number

赞成票总数

Pagination models.ts:1426

参数名 类型 说明
next number

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

page number

当前页码

pages number

总页数

per_page number

每页条数

previous number

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

total number

数据总数

ArticleRelationship models.ts:212

参数名 类型 说明
is_following boolean

当前登录用户是否已关注该文章

topics TopicInRelationship[]
user UserInRelationship
voting string

当前登录用户的投票类型(updown),未投过票则为空字符串

取值范围包括:updown

TopicInRelationship models.ts:1933

参数名 类型 说明
cover TopicCover
name string

话题名称

topic_id number

话题 ID

UserInRelationship models.ts:2162

参数名 类型 说明
avatar UserAvatar
headline string

一句话介绍

user_id number

用户ID

username string

用户名

TopicCover models.ts:1899

参数名 类型 说明
large string

大型封面地址

middle string

中型封面地址

original string

封面原图地址

small string

小型封面地址

UserAvatar models.ts:2094

参数名 类型 说明
large string

大头像地址

middle string

中头像地址

original string

头像原图地址

small string

小头像地址