API文档API文档
POST/api/articles
创建新文章
GET/api/articles
获取我的文章列表
GET/api/articles/search
搜索文章
GET/api/articles/{articleId}
获取文章详情
PUT/api/articles/{articleId}
更新文章
DELETE/api/articles/{articleId}
删除文章
POST/api/articles/{articleId}/restore
恢复删除的文章
POST/api/articles/{articleId}/publish
发布文章
POST/api/articles/{articleId}/unpublish
取消发布文章
GET/api/articles/group/{groupId}
获取群组文章列表
POST/api/articles
创建新文章
GET/api/articles
获取我的文章列表
GET/api/articles/search
搜索文章
GET/api/articles/{articleId}
获取文章详情
PUT/api/articles/{articleId}
更新文章
DELETE/api/articles/{articleId}
删除文章
POST/api/articles/{articleId}/restore
恢复删除的文章
POST/api/articles/{articleId}/publish
发布文章
POST/api/articles/{articleId}/unpublish
取消发布文章
GET/api/articles/group/{groupId}
获取群组文章列表
put/api/articles/{articleId}
put/api/articles/{articleId}
更新文章
基本信息
请求方法:
put
请求地址:
https://abit.fun/api/articles/{articleId}
标签:
文章管理
接口描述
更新指定文章的信息。仅作者可以执行此操作。
用途:
- 作者可以更新自己创建的文章
- 可以修改标题、内容和标签
路径参数
路径参数说明
路径参数是URL路径中的变量部分,例如:
https://abit.fun/api/articles/:articleId
参数名称 | 类型 | 必填 | 示例值 | 接口描述 |
---|---|---|---|---|
articleId | string | 必填 | example | 要更新的文章ID |
请求头参数
请求头参数说明
请求头参数用于传递额外的信息,如认证凭据、内容类型等。
参数名称 | 类型 | 必填 | 示例值 | 接口描述 |
---|---|---|---|---|
Authorization | string | 必填 | Bearer sha_1234567890abcdef... | 认证头用于验证API请求的身份,包含访问令牌 格式: Bearer {token} |
请求体参数
请求体参数说明
请求体参数用于传递复杂结构化数据,通常使用以下格式: application/json
参数详情
参数名称 | 类型 | 必填 | 示例值 | 接口描述 |
---|---|---|---|---|
title | string | 可选 | 如何高效学习编程:进阶技巧 | 文章标题 |
content | string | 可选 | 这是更新后的文章内容... | 文章内容,支持富文本格式 |
tags | array | 可选 | [
"编程",
"学习方法",
"效率",
"进阶"
] | 文章标签 |
JSON 示例
{
"title": "如何高效学习编程:进阶技巧",
"content": "这是更新后的文章内容...",
"tags": [
"编程",
"学习方法",
"效率",
"进阶"
]
}
响应示例
200文章更新成功
{
"success": true
}
400
401
403无权限更新文章
{
"success": false,
"message": "您没有权限更新该文章"
}
404文章不存在
{
"success": false,
"message": "文章不存在或已被删除"
}
500