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
取消发布小组文章
get/api/group/{groupId}/articles
get/api/group/{groupId}/articles
获取小组文章列表
Basic Information
Request Method:
get
Request URL:
https://www.lycoo.com/api/group/{groupId}/articles
Tags:
小组文章管理
Description
获取指定小组的所有文章列表。
用途:
- 查看小组内的所有文章
- 小组所有者或管理员可以查看所有文章,包括未发布的
- 普通小组成员可以查看所有文章,包括未发布的
- 文章作者可以查看自己创建的所有文章,包括未发布的
- 非小组成员只能查看已发布的文章,且仅限公开小组
Path Parameters
Path Parameters Explanation
Path parameters are variables in the URL path, for example:
https://www.lycoo.com/api/group/:groupId/articles
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
groupId | string | Required | example | 小组ID |
Query Parameters
Query Parameters Explanation
Query parameters are added at the end of the URL, starting with a question mark, for example:
https://www.lycoo.com/api/group/{groupId}/articles?page=10&pageSize=10
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
page | integer | Optional | 10 | 页码,默认为1 |
pageSize | integer | Optional | 10 | 每页条目数,默认为10 |
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} |
Response Example
200获取小组文章列表成功
{
"success": true
}
401
403无权限查看小组文章
{
"success": false,
"message": "您不是该小组成员,无法查看文章"
}
404
500