Skip to content

Commit 018f823

Browse files
apkqiulambdark
andauthored
add: 添加api(workshop/works.md)
Co-authored-by: lambdark <lambdark@outlook.com>
1 parent ad317fa commit 018f823

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

workshop/works.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# 工作室作品信息
2+
3+
> 获取工作室作品信息
4+
> `web/works/subjects/<workshop_id>/works` `GET`
5+
6+
## GET 请求信息
7+
8+
| KEY | VALUE | TYPE | |
9+
| :-------------: | :---------------------------------: | :---: | :----: |
10+
| offset | 起始编号 \[默认为 0\] | `int` | `可选` |
11+
| limit | 列举数量 \[默认为 15\] | `int` | `可选` |
12+
| sort | 排序方式[可选参数](#sort) | `str` | `可选` |
13+
| user_id | 将哪一个用户的作品排在最前 | `int` | `可选` |
14+
| work_subject_id | 如果指定,必须与`<workshop_id>`一致 | `int` | `可选` |
15+
16+
### sort
17+
18+
| 类型 ||
19+
| :------: | :-------------: |
20+
| 默认 | \[不指定\] |
21+
| 点赞 | -n_likes |
22+
| 发布时间 | -created_at,-id |
23+
24+
## 返回内容
25+
26+
| KEY | VALUE | TYPE |
27+
| :-----: | :-----------------------------------: | :--: |
28+
| counted | \[未知\] 返回总是 True | bool |
29+
| items | [查看详情](#items) | List |
30+
| limit | GET 参数中的 limit,如果没有,则为 15 | int |
31+
| offset | GET 参数中的 offset,如果没有,则为 0 | int |
32+
| total | items 的长度 | int |
33+
34+
### items
35+
36+
items 是列表类型
37+
38+
| KEY | VALUE | TYPE |
39+
| :----------: | :---------------------------: | :--: |
40+
| audited_at | 发布时间 | int |
41+
| id | 作品 id | int |
42+
| name | 作品名称 | str |
43+
| praise_times | 作品点赞数量 | int |
44+
| view_times | 作品浏览数量 | int |
45+
| preview | 作品封面图片 | str |
46+
| type | \[未知\] 大部分为"IDE" | str |
47+
| user | 用户信息([查看详情](#user)| dict |
48+
49+
#### user
50+
51+
| KEY | VALUE | TYPE |
52+
| :--------: | :------: | :--: |
53+
| avatar_url | 头像链接 | str |
54+
| gold | \[未知\] | str |
55+
| id | 用户 ID | str |
56+
| nickname | 用户昵称 | str |
57+
58+
> 更新于 {docsify-updated}

0 commit comments

Comments
 (0)