Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.

Commit 1dacac1

Browse files
committed
docs: update docs for statistics list view
1 parent 7436b4d commit 1dacac1

File tree

2 files changed

+59
-12
lines changed

2 files changed

+59
-12
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# 接口文档
22

3-
接口文档请查看 [docs/README.md](docs/README.md)
4-
5-
或查看 [在线接口文档](http://111.231.75.86:8000/docs/)
3+
点击查看 [在线接口文档](http://111.231.75.86:8000/docs/)
64

75

86
# 文档预览

docs/README.md

Lines changed: 58 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,18 @@
7575

7676
本系统主要是将从`丁香园`获取的数据重新整合成接口返回出来。
7777

78-
## 全球疫情 :id=statistics
78+
## 最新全球疫情 :id=statistics
7979

80-
获取全球整体疫情统计数据、相关文章、日常建议、推荐信息等;
80+
获取最新获取到的全球整体疫情统计数据、相关文章、日常建议、推荐信息等;
8181

82-
接口地址:/api/statistics/
82+
接口地址:/api/statistics/latest
8383

8484
请求方法:GET
8585

86+
请求示例:
87+
88+
http://111.231.75.86:8000/api/statistics/latest
89+
8690
返回结果:
8791

8892
```
@@ -183,7 +187,52 @@
183187
}
184188
```
185189

186-
## 国家疫情统计
190+
## 全球疫情列表 :id=statistics
191+
192+
获取项目从启动到当前获取到的全部疫情统计数据,分为全球、国内、国际三部分;
193+
194+
接口地址:/api/statistics/
195+
196+
请求方法:GET
197+
198+
请求示例:
199+
200+
http://111.231.75.86:8000/api/statistics/
201+
202+
返回结果:
203+
204+
```
205+
[
206+
{
207+
"globalStatistics": {
208+
"confirmedCount": 2913206,
209+
"curedCount": 826309,
210+
"deadCount": 206245,
211+
"seriousCount": 0,
212+
"currentConfirmedCount": 1880652,
213+
"suspectedCount": 0
214+
},
215+
"domesticStatistics": {
216+
"confirmedCount": 84341,
217+
"curedCount": 78558,
218+
"deadCount": 4643,
219+
"seriousCount": 974,
220+
"currentConfirmedCount": 1140,
221+
"suspectedCount": 1636
222+
},
223+
"internationalStatistics": {
224+
"confirmedCount": 2828865,
225+
"curedCount": 747751,
226+
"deadCount": 201602,
227+
"seriousCount": 0,
228+
"currentConfirmedCount": 1879512,
229+
"suspectedCount": 4
230+
}
231+
}
232+
]
233+
```
234+
235+
## 所有国家疫情
187236

188237
获取各个国家的疫情统计数据;
189238

@@ -221,7 +270,7 @@ http://111.231.75.86:8000/api/countries/?continents=南美洲,北美洲&countryN
221270
]
222271
```
223272

224-
## 某个国家疫情统计
273+
## 某国家疫情
225274

226275
根据国家名称获取某个国家的疫情统计数据;
227276

@@ -252,7 +301,7 @@ http://111.231.75.86:8000/api/countries/巴西/
252301
```
253302

254303

255-
## 中国省份(自治区、直辖市)疫情
304+
## 国内省份(自治区、直辖市)疫情
256305

257306
获取中国各中国省份(自治区、直辖市)的疫情统计数据;
258307

@@ -288,7 +337,7 @@ http://111.231.75.86:8000/api/provinces/?provinceShortNames=四川,香港
288337
]
289338
```
290339

291-
## 某个中国省份(自治区、直辖市)疫情
340+
## 某国内省份(自治区、直辖市)疫情
292341

293342
通过`短省份名`获取某个中国省份(自治区、直辖市)的疫情统计数据;
294343

@@ -320,7 +369,7 @@ http://111.231.75.86:8000/api/provinces/澳门/
320369
}
321370
```
322371

323-
## 中国城市或直辖市某个区疫情
372+
## 国内城市或直辖市某区疫情
324373

325374
获取中国各个城市或直辖市某个区的疫情数据。
326375

@@ -355,7 +404,7 @@ http://111.231.75.86:8000/api/cities/?cityNames=大庆,万州区
355404
]
356405
```
357406

358-
## 某个中国城市或直辖市某个区疫情
407+
## 某国内城市或直辖市某区疫情
359408

360409

361410
接口地址:/api/cities/\<CITY_NAME\>/

0 commit comments

Comments
 (0)