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

Commit ad34e91

Browse files
committed
docs: update README.md
1 parent 7442650 commit ad34e91

File tree

1 file changed

+133
-12
lines changed

1 file changed

+133
-12
lines changed

docs/README.md

Lines changed: 133 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@
7575

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

78-
## 最新全球疫情 :id=statistics
78+
## 全球疫情 :id=statistics
79+
80+
### Latest :id=statistics-latest
7981

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

@@ -187,7 +189,7 @@ http://111.231.75.86:8000/api/statistics/latest
187189
}
188190
```
189191

190-
## 全球疫情列表 :id=statistics
192+
### List :id=statistics-list
191193

192194
获取项目从启动到当前获取到的全部疫情统计数据,分为全球、国内、国际三部分;
193195

@@ -227,12 +229,64 @@ http://111.231.75.86:8000/api/statistics/
227229
"seriousCount": 0,
228230
"currentConfirmedCount": 1879512,
229231
"suspectedCount": 4
230-
}
232+
},
233+
"modifyTime": "2020-04-30T01:12:33Z",
234+
"createTime": "2020-01-20T16:31:39Z"
231235
}
232236
]
233237
```
234238

235-
## 所有国家疫情
239+
## 国家疫情 :id=country
240+
241+
### Daily List(Chart Data) :id=country-daily
242+
243+
根据国家名称获取某个国家的疫情从 2020-01-19 到目前的疫情列表数据;
244+
245+
接口地址:/api/countries/\<COUNTRY_NAME\>/daily/
246+
247+
请求方法:GET
248+
249+
示例链接:
250+
251+
http://111.231.75.86:8000/api/countries/美国/daily/
252+
253+
http://111.231.75.86:8000/api/countries/巴西/daily/
254+
255+
返回结果:
256+
257+
```
258+
[
259+
{
260+
"dateId": 20200119,
261+
"currentConfirmedCount": 188,
262+
"confirmedCount": 217,
263+
"suspectedCount": 0,
264+
"curedCount": 25,
265+
"deadCount": 4,
266+
"currentConfirmedIncr": 188,
267+
"confirmedIncr": 217,
268+
"suspectedCountIncr": 0,
269+
"curedIncr": 25,
270+
"deadIncr": 4
271+
},
272+
{
273+
"dateId": 20200120,
274+
"currentConfirmedCount": 188,
275+
"confirmedCount": 217,
276+
"suspectedCount": 0,
277+
"curedCount": 25,
278+
"deadCount": 4,
279+
"currentConfirmedIncr": 188,
280+
"confirmedIncr": 217,
281+
"suspectedCountIncr": 0,
282+
"curedIncr": 25,
283+
"deadIncr": 4
284+
},
285+
...
286+
]
287+
```
288+
289+
### List :id=country-list
236290

237291
获取各个国家的疫情统计数据;
238292

@@ -265,12 +319,18 @@ http://111.231.75.86:8000/api/countries/?continents=南美洲,北美洲&countryN
265319
"confirmedCount": 965785,
266320
"suspectedCount": 0,
267321
"curedCount": 106988,
268-
"deadCount": 54881
322+
"deadCount": 54881,
323+
"incrVo": {
324+
"confirmedIncr": 0,
325+
"currentConfirmedIncr": 0,
326+
"curedIncr": 0,
327+
"deadIncr": 0
328+
}
269329
}
270330
]
271331
```
272332

273-
## 某国家疫情
333+
### Detail :id=country-detail
274334

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

@@ -296,14 +356,73 @@ http://111.231.75.86:8000/api/countries/巴西/
296356
"confirmedCount": 965785,
297357
"suspectedCount": 0,
298358
"curedCount": 106988,
299-
"deadCount": 54881
359+
"deadCount": 54881,
360+
"incrVo": {
361+
"confirmedIncr": 0,
362+
"currentConfirmedIncr": 0,
363+
"curedIncr": 0,
364+
"deadIncr": 0
365+
}
300366
}
301367
```
302368

369+
## 省/自治区/直辖市
370+
371+
### Daily List(Chart Data)
372+
373+
通过`短省份名`获取某个中国省份(自治区、直辖市)的疫情从 2020-01-19 到目前的疫情列表数据;
374+
375+
接口地址:/api/provinces/\<PROVINCE_SHORT_NAME\>/daily/
376+
377+
请求方法:GET
378+
379+
示例链接:
380+
381+
http://111.231.75.86:8000/api/provinces/四川/daily/
382+
383+
http://111.231.75.86:8000/api/provinces/台湾/daily/
384+
385+
http://111.231.75.86:8000/api/provinces/香港/daily/
386+
387+
http://111.231.75.86:8000/api/provinces/澳门/daily/
388+
389+
返回结果:
303390

304-
## 国内省份(自治区、直辖市)疫情
391+
```
392+
[
393+
{
394+
"dateId": 20200119,
395+
"currentConfirmedCount": 188,
396+
"confirmedCount": 217,
397+
"suspectedCount": 0,
398+
"curedCount": 25,
399+
"deadCount": 4,
400+
"currentConfirmedIncr": 188,
401+
"confirmedIncr": 217,
402+
"suspectedCountIncr": 0,
403+
"curedIncr": 25,
404+
"deadIncr": 4
405+
},
406+
{
407+
"dateId": 20200120,
408+
"currentConfirmedCount": 188,
409+
"confirmedCount": 217,
410+
"suspectedCount": 0,
411+
"curedCount": 25,
412+
"deadCount": 4,
413+
"currentConfirmedIncr": 188,
414+
"confirmedIncr": 217,
415+
"suspectedCountIncr": 0,
416+
"curedIncr": 25,
417+
"deadIncr": 4
418+
},
419+
...
420+
]
421+
```
422+
423+
### List
305424

306-
获取中国各中国省份(自治区、直辖市)的疫情统计数据
425+
获取中国各中国省/自治区/直辖市的疫情统计数据
307426

308427
接口地址:/api/provinces/
309428

@@ -337,7 +456,7 @@ http://111.231.75.86:8000/api/provinces/?provinceShortNames=四川,香港
337456
]
338457
```
339458

340-
## 某国内省份(自治区、直辖市)疫情
459+
### Detail
341460

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

@@ -369,7 +488,9 @@ http://111.231.75.86:8000/api/provinces/澳门/
369488
}
370489
```
371490

372-
## 国内城市或直辖市某区疫情
491+
## 城市或直辖市某区
492+
493+
### List
373494

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

@@ -404,7 +525,7 @@ http://111.231.75.86:8000/api/cities/?cityNames=大庆,万州区
404525
]
405526
```
406527

407-
## 某国内城市或直辖市某区疫情
528+
### Detail
408529

409530

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

0 commit comments

Comments
 (0)