Skip to content

Commit 49f71ba

Browse files
committed
delete 无用的 API 描述
1 parent 0755149 commit 49f71ba

File tree

1 file changed

+4
-123
lines changed

1 file changed

+4
-123
lines changed

doc/api.md

Lines changed: 4 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151
## 二、基础接口
5252

53-
### 2.1 获取所有分类信息
53+
### 2.1 获取所有月刊分类的信息
5454
PATH:`GET /api/v1/category/`
5555

5656
参数:无
@@ -73,7 +73,7 @@ PATH:`GET /api/v1/category/`
7373
}
7474
```
7575

76-
### 2.2 获取所有期的信息
76+
### 2.2 获取所有月刊期的信息
7777
PATH:`GET /api/v1/volume/`
7878

7979
参数:无
@@ -198,89 +198,7 @@ PATH:`GET /api/v1/traffic/views/`
198198
}
199199
```
200200

201-
### 3.2 获取用户访问来源统计数据
202-
203-
用户访问来源统计数据用于图表展示。(折线图)
204-
205-
PATH:`GET /api/v1/traffic/from/view/`
206-
207-
参数:
208-
209-
| 名称 | 必须 | 类型 | 描述 |
210-
| ------- | ----- | ----- | ----- |
211-
| start_time || int | 开始时间戳 |
212-
| end_time || int | 结束时间戳 |
213-
214-
响应:
215-
```
216-
{
217-
"message": "OK",
218-
"payload": {
219-
"start_time": 1573713003,
220-
"end_time": 1573723003,
221-
"per": "hour", #时间聚合的维度分:day和hour
222-
"all_count": 400, #该时间段的总数
223-
"data": [
224-
{
225-
"id": 13, #来源分类的id
226-
"referrer": "谷歌", #来源
227-
"count": 30, #数量
228-
"percent": 0.41 #占比
229-
"timeline": [
230-
{
231-
"timestamp": 1573713003,
232-
"count": 3
233-
},
234-
...
235-
]
236-
},
237-
...
238-
}
239-
]
240-
}
241-
}
242-
```
243-
244-
### 3.3 获取推荐项目点击统计数据
245-
246-
推荐项目点击统计数据用于图表展示。(折线图)
247-
248-
PATH:`GET /api/v1/traffic/click/view/`
249-
250-
参数:
251-
252-
| 名称 | 必须 | 类型 | 描述 |
253-
| ------- | ----- | ----- | ----- |
254-
| start_time || int | 开始时间戳 |
255-
| end_time || int | 结束时间戳 |
256-
257-
响应:
258-
```
259-
{
260-
"message": "OK",
261-
"payload": {
262-
"start_time": 1573713003,
263-
"end_time": 1573723003,
264-
"per": "hour", #时间聚合的维度分:day和hour
265-
"all_count": 400, #该时间段的总数
266-
"all_ip_count": 322, #IP总数
267-
"data": [
268-
{
269-
"category_id": 1,
270-
"category_name": "Python 项目",
271-
"timestamp": "1573713003", #时间
272-
"count": 440, #某一时间段项目的点击数量
273-
"ip_count": 322 # IP数量
274-
},
275-
...
276-
]
277-
}
278-
]
279-
}
280-
}
281-
```
282-
283-
### 3.4 获取推荐项目点击详细数据
201+
### 3.2 获取推荐项目点击详细数据
284202

285203
返回推荐项目点击统计列表的数据
286204

@@ -330,44 +248,7 @@ PATH:`GET /api/v1/traffic/click/detail/`
330248
}
331249
```
332250

333-
### 3.5 获取某一期月刊的统计数据
334-
335-
某一期月刊的统计数据用于图表展示。(双条形图)
336-
337-
PATH:`GET /api/v1/traffic/periodical/view/`
338-
339-
参数:
340-
341-
| 名称 | 必须 | 类型 | 描述 |
342-
| ------- | ----- | ----- | ----- |
343-
| volume_id || int | 期刊的 id,默认为最新一期 |
344-
| category_id || int | 期刊分类的 id,默认返回所有分类的数据|
345-
346-
响应:
347-
```
348-
{
349-
"message": "OK",
350-
"payload": {
351-
"all_count": 400, #该时间段的总数
352-
"all_ip_count": 322, #IP总数
353-
"data": [
354-
{
355-
"category_id": 1,
356-
"category_name": "Python 项目",
357-
"volume_id": 1,
358-
"volume_name": "01",
359-
"count": 440, #某一时间段项目的点击数量
360-
"ip_count": 322 # IP数量
361-
},
362-
...
363-
]
364-
}
365-
]
366-
}
367-
}
368-
```
369-
370-
### 3.6 获取某一期月刊的详细数据
251+
### 3.3 获取某一期月刊的详细数据
371252

372253
某一期月刊的统计数据用于列表的数据。
373254

0 commit comments

Comments
 (0)