API DocsAPI Docs
POST/api/group/{groupId}/articles
在指定小组创建空白文章
GET/api/group/{groupId}/articles
获取小组文章列表
GET/api/group/{groupId}/article/{articleId}
获取小组文章详情
PUT/api/group/{groupId}/article/{articleId}
实时更新小组文章
DELETE/api/group/{groupId}/article/{articleId}
删除小组文章
GET/api/group/{groupId}/article/{articleId}/draft
获取小组草稿文章详情
POST/api/group/{groupId}/article/{articleId}/restore
恢复删除的小组文章
PUT/api/group/{groupId}/article/{articleId}/publish
发布小组文章
PUT/api/group/{groupId}/article/{articleId}/unpublish
取消发布小组文章
POST/api/group/{groupId}/articles
在指定小组创建空白文章
GET/api/group/{groupId}/articles
获取小组文章列表
GET/api/group/{groupId}/article/{articleId}
获取小组文章详情
PUT/api/group/{groupId}/article/{articleId}
实时更新小组文章
DELETE/api/group/{groupId}/article/{articleId}
删除小组文章
GET/api/group/{groupId}/article/{articleId}/draft
获取小组草稿文章详情
POST/api/group/{groupId}/article/{articleId}/restore
恢复删除的小组文章
PUT/api/group/{groupId}/article/{articleId}/publish
发布小组文章
PUT/api/group/{groupId}/article/{articleId}/unpublish
取消发布小组文章
put/api/group/{groupId}/article/{articleId}
put/api/group/{groupId}/article/{articleId}
实时更新小组文章
Basic Information
Request Method:
put
Request URL:
https://www.lycoo.com/api/group/{groupId}/article/{articleId}
Tags:
小组文章管理
Description
实时更新指定小组内特定文章的信息。仅作者或小组管理员可以执行此操作。
设计用于前端实时保存,支持空白内容,优化编辑体验。
用途:
- 支持用户边写边保存
- 作者可以更新自己创建的文章
- 可以修改标题、内容、标签、发布状态
- 支持修改部分字段,不需要提供完整数据
Path Parameters
Path Parameters Explanation
Path parameters are variables in the URL path, for example:
https://www.lycoo.com/api/group/:groupId/article/:articleId
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
groupId | string | Required | example | 小组ID |
articleId | string | Required | example | 要更新的文章ID |
Header Parameters
Header Parameters Explanation
Header parameters are used to pass additional information, such as authentication credentials, content type, etc.
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
Authorization | string | Required | Bearer sha_1234567890abcdef... | The authentication header is used to verify the identity of API requests, containing an access token Format: Bearer {token} |
Request Body Parameters
Request Body Parameters Explanation
Request body parameters are used to pass complex structured data, typically using the following format: application/json
Parameter Details
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
title | string | Optional | 如何高效学习编程 | 文章标题,可以为空字符串 |
content | string | Optional | 这是更新后的文章内容... | 文章内容,支持富文本格式,可以为空字符串 |
isPublished | boolean | Optional | true | 是否发布文章 |
poiId | string | Optional | 550e8400-e29b-41d4-a716-446655440000 | 关联的POI地点ID,可以为null表示删除关联 格式: uuid |
occurredAt | string | Optional | 2025-05-15T10:00:00Z | 文章内容实际发生的时间点 格式: date-time |
images | array | Optional | 25 | 关联的图片列表,按顺序显示,仅包含图片ID的数组 |
JSON Example
{
"title": "如何高效学习编程",
"content": "这是更新后的文章内容...",
"isPublished": true,
"poiId": "550e8400-e29b-41d4-a716-446655440000",
"occurredAt": "2025-05-15T10:00:00Z"
}
Response Example
200文章更新成功
{
"success": true
}
400请求参数错误
{
"success": false,
"message": "请求参数错误"
}
401
403无权限更新文章
{
"success": false,
"message": "您没有权限更新该文章"
}
404文章不存在或小组不存在
{
"success": false,
"message": "文章不存在、已被删除或不属于该小组"
}
500