Skip to content

Commit 1acf9e8

Browse files
medzmedz
committed
chore: 提交新的文档代码
1 parent ff8db73 commit 1acf9e8

File tree

167 files changed

+4252
-8797
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

167 files changed

+4252
-8797
lines changed

‎.babelrc

-3
This file was deleted.

‎.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto

‎.gitignore

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
/node_modules/
2-
yarn-error.log
3-
.DS_Store
1+
node_modules
2+
.DS_Store
3+
lib/core/metadata.js
4+
lib/core/MetadataBlog.js
5+
website/translated_docs
6+
website/build/
7+
website/yarn.lock
8+
website/node_modules
9+
10+
website/i18n/*
11+
!website/i18n/en.json

‎404.html

-1
This file was deleted.

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# docs

‎assets/app.js

-1
This file was deleted.

‎assets/manifest.js

-1
This file was deleted.

‎assets/vendor.js

-41
This file was deleted.

‎docs/android-started.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
id: android-started
3+
title: Overview
4+
---

‎docs/v2/core/aboutus.md ‎docs/api-v2-aboutus.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# 关于我们
2-
3-
- [关于我们页面](#关于我们页面)
1+
---
2+
id: api-v2-aboutus
3+
title: 关于我们
4+
---
45

56
## 关于我们页面
67

@@ -14,4 +15,4 @@ GET /api/v2/aboutus
1415
Status 200 Ok
1516
```
1617

17-
Html 页面
18+
HTML 页面

‎docs/v2/core/ad.md ‎docs/api-v2-ad.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# 广告
1+
---
2+
id: api-v2-ad
3+
title: 广告
4+
---
25

36
- [获取所有广告位](#查询所有广告位)
47
- [获取一个广告位的广告列表](#获取一个广告位的广告列表)
@@ -181,4 +184,4 @@ Status: 200 OK
181184
"updated_at": "2017-07-27 15:09:16"
182185
}
183186
]
184-
```
187+
```

‎docs/v2/bootstrappers.md ‎docs/api-v2-bootstrappers.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# 启动信息
1+
---
2+
id: api-v2-bootstrappers
3+
title: 启动信息
4+
---
25

36
启动信息是在调用接口前的需求，可以在应用启动的时候一次性获取全部通用配置信息。
47

@@ -133,4 +136,3 @@ Status: 200 OK
133136
| registerSettings.content | 用户服务条款及隐私政策 | | 类型：string，格式：markdown |
134137
| registerSettings.type | 用户注册方式 | invited: 仅邀请， all: 全部， thirdPart: 第三方 | 注册方式控制类型：string |
135138
| registerSettings.method | 用户注册类型 | mobile-only: 仅手机， mail-only: 仅邮箱，all： 邮箱或手机 | 类型：string |
136-

‎docs/v2/core/currency.md ‎docs/api-v2-currency.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: api-v2-currency
3+
title: 积分
4+
---
5+
16
# 积分部分
27

38
- [获取积分配置](#获取积分配置)
@@ -262,4 +267,3 @@ Http Status 201
262267
]
263268
}
264269
```
265-

‎docs/api-v2-feeds-collect.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
id: api-v2-feeds-collect
3+
title: 收藏
4+
---
5+
6+
- [收藏](#收藏)
7+
- [取消收藏](#取消收藏)
8+
- [收藏列表](#收藏列表)
9+
10+
## 收藏
11+
12+
```
13+
POST /feeds/:feed/collections
14+
```
15+
16+
#### Response
17+
18+
```
19+
Status: 201 Created
20+
```
21+
```json
22+
{
23+
"message": [
24+
"收藏成功"
25+
]
26+
}
27+
```
28+
29+
## 取消收藏
30+
31+
```
32+
DELETE /feeds/:feed/uncollect
33+
```
34+
35+
#### Response
36+
37+
```
38+
Status: 204 No Centent
39+
```
40+
41+
## 收藏列表
42+
43+
```
44+
GET /feeds/collections
45+
```
46+
47+
### Parameters
48+
49+
| 名称 | 类型 | 描述 |
50+
|:----:|:----:|----|
51+
| limit | Integer | 可选，默认值 20 ，获取条数 |
52+
| offset | Integer | 可选，偏移量，用于翻页，传入已请求过的数据总数 |
53+
| user | Integer | type = `users` 时可选，默认值为当前用户id |
54+
55+
> 列表为倒序
56+
57+
#### Response
58+
59+
```
60+
Status: 200 OK
61+
```
62+
```json5
63+
[
64+
{...} // 数据参考动态单条内容
65+
]
66+
```
67+
68+
> `feed_content` 字段在列表中，如果是收费动态则只返回 100 个文字。

‎docs/api-v2-feeds-comment-pay.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
id: api-v2-feeds-comment-pay
3+
title: 设置评论收费
4+
---
5+
6+
```
7+
PATCH /feeds/:feed/comment-paid
8+
```
9+
10+
## Input
11+
| 名称 | 类型 | 描述 |
12+
|:----:|:----:|----|
13+
| amount | Integer | 收费金额 |
14+
15+
#### Response
16+
17+
```
18+
Status: 201 Created
19+
```
20+
```json
21+
{
22+
"message": [
23+
"设置成功"
24+
],
25+
"paid_node": 11
26+
}
27+
```

‎docs/api-v2-feeds-comments.md

+158
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
id: api-v2-feeds-comments
3+
title: 评论
4+
---
5+
6+
- [Send comment](#send-comment)
7+
- [Get all comments](#get-all-comments)
8+
- [Get a single comment](#get-a-single-comment)
9+
- [Delete comment](#delete-comment)
10+
11+
## Send comment
12+
13+
```
14+
POST /feeds/:feed/comments
15+
```
16+
17+
#### Input
18+
19+
| Name | Type | Description
20+
|:----:|:----:|----|
21+
| body | String | Comment body. |
22+
| reply_user | Integer | Reply comment to users. |
23+
24+
##### Response
25+
26+
```
27+
Status: 201 Created
28+
```
29+
```json
30+
{
31+
"message": [
32+
"操作成功"
33+
],
34+
"comment": {
35+
"user_id": 1,
36+
"reply_user": 0,
37+
"target_user": 1,
38+
"body": "我是第三条评论",
39+
"commentable_type": "feeds",
40+
"commentable_id": 1,
41+
"updated_at": "2017-07-20 08:53:24",
42+
"created_at": "2017-07-20 08:53:24",
43+
"id": 3
44+
}
45+
}
46+
```
47+
48+
## Get all comments
49+
50+
```
51+
GET /feeds/:feed/comments
52+
```
53+
54+
#### Parameters
55+
56+
| Name | Type | Description |
57+
|:----:|:----:|----|
58+
| limit | Integer | List comments limit, By default `20`. |
59+
| after | Integer | The integer ID of the last Comment that you've seen. |
60+
61+
##### Response
62+
63+
```
64+
Status: 200 OK
65+
```
66+
```json
67+
{
68+
"pinneds": [
69+
{
70+
"id": 2,
71+
"user_id": 1,
72+
"target_user": 1,
73+
"reply_user": 0,
74+
"body": "我是第一条评论",
75+
"commentable_id": 1,
76+
"commentable_type": "feeds",
77+
"created_at": "2017-07-20 08:35:18",
78+
"updated_at": "2017-07-20 08:35:18"
79+
}
80+
],
81+
"comments": [
82+
{
83+
"id": 3,
84+
"user_id": 1,
85+
"target_user": 1,
86+
"reply_user": 0,
87+
"body": "我是第三条评论",
88+
"commentable_id": 1,
89+
"commentable_type": "feeds",
90+
"created_at": "2017-07-20 08:53:24",
91+
"updated_at": "2017-07-20 08:53:24"
92+
}
93+
]
94+
}
95+
```
96+
97+
| Name | Description |
98+
|:----:|----|
99+
| pinneds | Pinned comments list. |
100+
| comment | Comments list. |
101+
| *.id | The `ID` of the comment. |
102+
| *.user_id | Commentator. |
103+
| *.target_user | Own dynamic publisher. |
104+
| *.reply_user | Reverted to the user. |
105+
| *.body | The `body` of the comment. |
106+
| *.commentable_id | Feeds id. |
107+
| *.commentable_type | Commentable type. |
108+
| *.created_at | Comment release time. |
109+
| *.updated_at | Comment update time. |
110+
111+
## Get a single comment
112+
113+
```
114+
GET /feeds/:feed/comments/:comment
115+
```
116+
117+
##### Response
118+
119+
```
120+
Status: 200 OK
121+
```
122+
```json
123+
{
124+
"id": 1,
125+
"user_id": 1,
126+
"target_user": 1,
127+
"reply_user": 0,
128+
"body": "我是第一条评论",
129+
"commentable_id": 1,
130+
"commentable_type": "feeds",
131+
"created_at": "2017-07-20 08:34:41",
132+
"updated_at": "2017-07-20 08:34:41"
133+
}
134+
```
135+
136+
| Name | Description |
137+
|:----:|----|
138+
| id | The `ID` of the comment. |
139+
| user_id | Commentator. |
140+
| target_user | Own dynamic publisher. |
141+
| reply_user | Reverted to the user. |
142+
| body | The `body` of the comment. |
143+
| commentable_id | Feeds id. |
144+
| commentable_type | Commentable type. |
145+
| created_at | Comment release time. |
146+
| updated_at | Comment update time. |
147+
148+
## Delete comment
149+
150+
```
151+
DELETE /feeds/:feed/comments/:comment
152+
```
153+
154+
##### Response
155+
156+
```
157+
Status: 204 No Content
158+
```

0 commit comments

Comments
 (0)