Skip to content

Commit 59fe3d6

Browse files
shumuuulambdark
andauthored
improvement: 修订api(work/details)中的内容 (#24)
Co-authored-by: lambdark <lambdark@outlook.com>
1 parent ad3dc7c commit 59fe3d6

File tree

1 file changed

+56
-45
lines changed

1 file changed

+56
-45
lines changed

work/details.md

+56-45
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,69 @@
11
# 作品信息
22

3-
!> 这个 API 文档正在编写中,请勿使用
4-
53
> 获取作品信息
64
> `/creation-tools/v1/works/<work_id>` `GET`
75
86
## 返回内容
97

10-
| key | value | type |
11-
| :------------------: | :------------------------------------: | :----: |
12-
| id | 作品 ID | string |
13-
| work_name | 作品 ID | string |
14-
| type | | |
15-
| ide_type | 编辑器类型(Kitten2,Kitten3,Kitten4) | string |
16-
| operation | | |
17-
| description | | |
18-
| orientation | | |
19-
| parent_id | | |
20-
| parent_user_name | | |
21-
| player_url | player 链接 | string |
22-
| share_url | 分享链接 | string |
23-
| n_tree_nodes | | |
24-
| view_times | | |
25-
| collect_times | | |
26-
| share_times | | |
27-
| fork_enable | 是否开放再创作 | bool |
28-
| preview | | |
29-
| bcm_version | | |
30-
| bcm_url | | |
31-
| screenshot_cover_url | | |
32-
| n_roles | | |
33-
| n_brick | | |
34-
| comment_times | | |
35-
| publish_time | | |
36-
| user_info | 作品作者信息([查看详情](#user_info)| JSON |
37-
| abilities | 作品作者信息([查看详情](#abilities)| JSON |
38-
| work_label_list | | |
8+
| key | value | type |
9+
| :------------------: | :--------------------------------------: | :-----: |
10+
| id | 作品 ID | string |
11+
| work_name | 作品名称 | string |
12+
| type | 编辑器类型(Kitten2,Kitten3,Kitten4 等) | string |
13+
| ide_type | 编辑器系列 | string |
14+
| operation | 操作说明 | string |
15+
| description | 作品介绍 | string |
16+
| orientation | `未知` | int |
17+
| parent_id | `未知` | int |
18+
| parent_user_name | `未知` | string |
19+
| player_url | player 链接 | string |
20+
| share_url | 分享链接 | string |
21+
| unify_share_url | `未知` | string |
22+
| n_tree_nodes | 作品再创作数 | int |
23+
| view_times | 作品浏览量 | int |
24+
| collect_times | 作品收藏数 | int |
25+
| share_times | 作品分享数 | int |
26+
| fork_enable | 是否开放再创作 | boolean |
27+
| fork_scope | `未知` | int |
28+
| preview | 作品封面 | string |
29+
| bcm_version | 编辑器版本 | string |
30+
| bcm_url | `未知` | string |
31+
| screenshot_cover_url | 作品社区页启动界面图 | string |
32+
| n_roles | `未知` | int |
33+
| n_brick | `未知` | int |
34+
| comment_times | 评论数 | int |
35+
| publish_time | 作品发布时间 | int |
36+
| user_info | 作品作者信息([查看详情](#user_info)| JSON |
37+
| abilities | 作品作者信息([查看详情](#abilities)| JSON |
38+
| work_label_list | 作品标签([查看详情](#work_label_list)| array |
39+
| player_display_type | | int |
3940

4041
### user_info
4142

42-
| key | value | type |
43-
| :---------: | :------------: | :----: |
44-
| id | 用户 ID | int |
45-
| nickname | 用户昵称 | string |
46-
| avatar_url | 用户头像链接 | string |
47-
| n_works | `未知` | int |
48-
| total_likes | 用户被点赞总数 | int |
49-
| is_followed | 是否关注该用户 | bool |
50-
| description | 用户自我描述 | string |
43+
| key | value | type |
44+
| :-----------------------: | :----------: | :----: |
45+
| id | 用户 ID | int |
46+
| nickname | 用户昵称 | string |
47+
| avatar | 用户头像链接 | string |
48+
| nickname | 用户昵称 | string |
49+
| fork_user | `未知` | string |
50+
| description | 个性签名 | string |
51+
| author_level | 作者等级 | int |
52+
| consume_level | `未知` | int |
53+
| is_official_certification | 官方认证 | int |
5154

5255
### abilities
5356

54-
| key | value | type |
55-
| :----------: | :---: | :--: |
56-
| is_collected | | |
57-
| is_praised | | |
58-
| is_owned | | |
57+
| key | value | type |
58+
| :----------: | :--------------: | :-----: |
59+
| is_collected | 访客是否收藏作品 | boolean |
60+
| is_praised | 访客是否点赞作品 | boolean |
61+
| is_owned | 访客是否为作者 | boolean |
62+
63+
### work_label_list
64+
65+
| key | value | type |
66+
| :--------: | :--------: | :----: |
67+
| label_type | 标签内部名 | string |
68+
| label_id | `未知` | int |
69+
| label_name | 标签名 | string |

0 commit comments

Comments
 (0)