这篇文章上次修改于 902 天前，可能其部分内容已经发生变化，如有疑问可询问作者。
对于非查询类接口，请求时 Header 中需要填写 X-Token 参数。
1. 类别相关
1.1. 创建类别
(1) 接口描述
本接口 (CreateCategory) 用于创建一个类别。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：CreateCategory。 |
| CategoryName | 是 | String | 类别名称。 |
| CategoryIndex | 否 | String | 类别序号。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CategoryId | Integer | 类别 ID |
| RequestId | String | 唯一请求 ID。 |
1.2. 删除类别
(1) 接口描述
本接口 (DeleteCategory) 用于删除一个类别。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：DeleteCategory。 |
| CategoryId | 是 | Integer | 类别 ID |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID。 |
1.3. 修改类别
(1) 接口描述
本接口 (ModifyCategory) 用于修改一个类别。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：ModifyCategory。 |
| CategoryId | 是 | Integer | 类别 ID |
| CategoryName | 是 | String | 类别名称。 |
| CategoryIndex | 否 | String | 类别序号。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID。 |
1.4. 查询类别
(1) 接口描述
本接口 (DescribeCategories) 用于查询类别。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：DescribeCategories。 |
| CategoryId | 否 | Integer | 类别 ID |
| Offset | 否 | Integer | 偏移量。 |
| Limit | 否 | Integer | 返回数量。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 符合条件的类别数量。 |
| CategorySet | Array of CategoryInfo | 类别详细信息列表。 |
| RequestId | String | 唯一请求 ID。 |
CategoryInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Category | Category | 类别详细信息。 |
| ArticleCount | Integer | 文章数量。 |
Category
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CategoryId | Integer | 类别 ID。 |
| CategoryName | String | 类别名称。 |
| CategoryIndex | String | 类别序号。 |
2. 标签相关
2.1. 创建标签
(1) 接口描述
本接口 (CreateTag) 用于创建一个标签。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：CreateTag。 |
| TagName | 是 | String | 标签名称。 |
| TagIndex | 否 | String | 标签序号。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TagId | Integer | 标签 ID |
| RequestId | String | 唯一请求 ID。 |
2.2. 删除标签
(1) 接口描述
本接口 (DeleteTag) 用于删除一个标签。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：DeleteTag。 |
| TagId | 是 | Integer | 标签 ID |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID。 |
2.3. 修改标签
(1) 接口描述
本接口 (ModifyTag) 用于修改一个类别。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：ModifyTag。 |
| TagId | 是 | Integer | 标签 ID |
| TagName | 是 | String | 标签名称。 |
| TagIndex | 否 | String | 标签序号。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID。 |
2.4. 查询标签
本接口 (DescribeTags) 用于查询标签。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：DescribeTags。 |
| TagId | 否 | Integer | 标签 ID |
| Offset | 否 | Integer | 偏移量。 |
| Limit | 否 | Integer | 返回数量。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 符合条件的标签数量。 |
| TagSet | Array of TagInfo | 标签详细信息列表。 |
| RequestId | String | 唯一请求 ID。 |
TagInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Tag | Tag | 标签详细信息。 |
| ArticleCount | Integer | 文章数量。 |
Tag
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TagId | Integer | 标签 ID。 |
| TagName | String | 标签名称。 |
| TagIndex | String | 标签序号。 |
3. 文章相关
3.1. 创建文章
(1) 接口描述
本接口 (CreateArticle) 用于创建一篇文章。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：CreateArticle。 |
| Title | 是 | String | 文章标题。 |
| CategoryId | 是 | Integer | 文章类别 ID。 |
| TagIds | 否 | String | 一个或多个文章标签 ID，以逗号分隔。 |
| Content | 是 | String | 文章内容。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ArticleId | Integer | 文章 ID |
| RequestId | String | 唯一请求 ID。 |
2.2. 删除文章
(1) 接口描述
本接口 (DeleteArticle) 用于删除一篇文章。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：DeleteArticle。 |
| ArticleId | 是 | Integer | 文章 ID |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID。 |
2.3. 修改文章
(1) 接口描述
本接口 (ModifyArticle) 用于修改一篇文章。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：ModifyArticle。 |
| ArticleId | 是 | Integer | 文章 ID |
| Title | 是 | String | 标题。 |
| CategoryId | 是 | Integer | 文章类别 ID。 |
| TagIds | 否 | String | 一个或多个文章标签 ID，以逗号分隔。 |
| Content | 是 | String | 文章内容。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID。 |
2.4. 查询文章
本接口 (DescribeArticles) 用于查询标签。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：DescribeArticles。 |
| ArticleId | 否 | Integer | 文章 ID |
| CategoryId | 否 | Integer | 文章类别 ID |
| TagId | 否 | Integer | 文章标签 ID |
| Keyword | 否 | String | 关键词 |
| Offset | 否 | Integer | 偏移量。 |
| Limit | 否 | Integer | 返回数量。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 符合条件的文章数量。 |
| ArticleSet | Array of ArticleInfo | 文章详细信息列表。 |
| RequestId | String | 唯一请求 ID。 |
ArticleInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Article | Article | 文章详细信息。 |
| Category | Category | 类别详细信息。 |
| TagSet | Array of Tag | 标签详细信息。 |
| RemarkCount | Integer | 评论总数。 |
Article
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ArticleId | Integer | 文章 ID。 |
| Title | String | 文章标题。 |
| CategoryId | Integer | 文章类别 ID。 |
| TagIds | String | 一个或多个文章标签 ID，以逗号分隔。 |
| Content | String | 文章内容。 |
| CreatedTime | Timestamp | 文章创建时间。 |
4. 评论相关
4.1. 创建评论
(1) 接口描述
本接口 (CreateRemark) 用于创建一条评论。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：CreateRemark。 |
| ArticleId | 是 | Integer | 文章 ID。 |
| Nickname | 是 | String | 评论者昵称。 |
| Content | 是 | String | 评论内容。 |
| InitRemarkId | 否 | Integer | 被回复的最初评论 ID。 |
| NicknameReplied | 否 | String | 被回复者昵称。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RemarkId | Integer | 评论 ID。 |
| RequestId | String | 唯一请求 ID。 |
4.2. 删除评论
(1) 接口描述
本接口 (DeleteRemark) 用于删除一条评论。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：DeleteRemark。 |
| RemarkId | 是 | Integer | 评论 ID。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID。 |
4.3. 修改评论
(1) 接口描述
本接口 (ModifyRemark) 用于修改一条评论。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：ModifyRemark。 |
| RemarkId | 是 | Integer | 评论 ID。 |
| Content | 是 | String | 评论内容。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID。 |
4.4. 查询评论
(1) 接口描述
本接口 (DescribeRemarks) 用于查询评论。
(2) 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 取值：DescribeRemarks。 |
| ArticleId | 否 | Integer | 文章 ID。 |
| Offset | 否 | Integer | 偏移量。 |
| Limit | 否 | Integer | 返回数量。 |
(3) 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 符合条件的评论数量。 |
| RemarkSet | Array of RemarkInfo | 评论详细信息列表。 |
| RequestId | String | 唯一请求 ID。 |
RemarkInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Remark | Remark | 评论详细信息。 |
| ReplySet | Array of Remark | 评论回复详细信息列表。 |
Remark
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RemarkId | Integer | 评论 ID。 |
| Nickname | String | 评论者昵称。 |
| Content | String | 评论内容。 |
| InitRemarkId | Integer | 被回复的最初的评论 ID。 |
| NicknameReplied | String | 被回复者昵称。 |
| CreatedTime | Timestamp | 评论创建时间。 |
没有评论