menu MDClub JavaScript SDK 文档

ArticleApi.get

获取指定文章信息。

方法定义

ArticleApi.get(param: GetParams): Promise<ArticleResponse>

参数

GetParams ArticleApi.ts:104

参数名必选类型说明
article_idnumber

文章ID

includestring

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

响应

ArticleResponse models.ts:230

参数名类型说明
codenumber

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

dataArticle

Article models.ts:118

参数名类型说明
article_idnumber

文章ID

comment_countnumber

评论数量

content_markdownstring

Markdown 格式的文章内容

content_renderedstring

HTML 格式的文章内容

create_timenumber

创建时间

delete_timenumber

🔐删除时间

follower_countnumber

关注者数量

relationshipsArticleRelationship
titlestring

文章标题

update_timenumber

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

user_idnumber

用户ID

vote_countnumber

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

vote_down_countnumber

反对票总数

vote_up_countnumber

赞成票总数

ArticleRelationship models.ts:212

参数名类型说明
is_followingboolean

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

topicsTopicInRelationship[]
userUserInRelationship
votingstring

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

取值范围包括:updown

TopicInRelationship models.ts:1933

参数名类型说明
coverTopicCover
namestring

话题名称

topic_idnumber

话题 ID

UserInRelationship models.ts:2162

参数名类型说明
avatarUserAvatar
headlinestring

一句话介绍

user_idnumber

用户ID

usernamestring

用户名

TopicCover models.ts:1899

参数名类型说明
largestring

大型封面地址

middlestring

中型封面地址

originalstring

封面原图地址

smallstring

小型封面地址

UserAvatar models.ts:2094

参数名类型说明
largestring

大头像地址

middlestring

中头像地址

originalstring

头像原图地址

smallstring

小头像地址