Skip to content

Commit a55e03e

Browse files
author
ExpDev07
committed
update README with doc
1 parent 88a6faf commit a55e03e

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

README.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,10 @@ curl https://coronavirus-tracker-api.herokuapp.com/v2/locations | json_pp
4848

4949
### Swagger/OpenAPI
5050

51-
An [interactive SwaggerUI](https://coronavirus-tracker-api.herokuapp.com/) exists for the `v2` endpoints.
51+
Consume our API through [an interactive SwaggerUI](https://coronavirus-tracker-api.herokuapp.com/) (on mobile, use the [mobile friendly ReDocs](https://coronavirus-tracker-api.herokuapp.com/docs) instead for the best experience).
5252

53-
Mobile friendly ReDocs can be reached at https://coronavirus-tracker-api.herokuapp.com/docs
5453

55-
The [OpenAPI](https://swagger.io/docs/specification/about/) json can be downloaded at https://coronavirus-tracker-api.herokuapp.com/openapi.json
54+
The [OpenAPI](https://swagger.io/docs/specification/about/) json definition can be downloaded at https://coronavirus-tracker-api.herokuapp.com/openapi.json
5655

5756
## API Endpoints
5857

@@ -130,6 +129,7 @@ __Sample response__
130129
"country": "Norway",
131130
"country_code": "NO",
132131
"province": "",
132+
"county": "",
133133
"last_updated": "2020-03-21T06:59:11.315422Z",
134134
"coordinates": { },
135135
"latest": { },
@@ -174,6 +174,7 @@ __Sample response__
174174
"country": "Thailand",
175175
"country_code": "TH",
176176
"province": "",
177+
"county": "",
177178
"last_updated": "2020-03-21T06:59:11.315422Z",
178179
"coordinates": {
179180
"latitude": "15",
@@ -190,6 +191,7 @@ __Sample response__
190191
"country": "Norway",
191192
"country_code": "NO",
192193
"province": "",
194+
"county": "",
193195
"last_updated": "2020-03-21T06:59:11.315422Z",
194196
"coordinates": {
195197
"latitude": "60.472",
@@ -239,29 +241,30 @@ GET /v2/locations?country_code=IT
239241
__Sample Response__
240242
```json
241243
{
242-
"latest": {
243-
"confirmed": 59138,
244-
"deaths": 5476,
245-
"recovered": 7024
246-
},
247-
"locations": [
248-
{
249-
"coordinates": {
250-
"latitude": "43",
251-
"longitude": "12"
252-
},
253-
"country": "Italy",
254-
"country_code": "IT",
255-
"id": 16,
256-
"last_updated": "2020-03-23T13:32:23.913872Z",
257-
"latest": {
258-
"confirmed": 59138,
259-
"deaths": 5476,
260-
"recovered": 7024
261-
},
262-
"province": ""
263-
}
264-
]
244+
"latest": {
245+
"confirmed": 59138,
246+
"deaths": 5476,
247+
"recovered": 7024
248+
},
249+
"locations": [
250+
{
251+
"id": 16,
252+
"country": "Italy",
253+
"country_code": "IT",
254+
"province": "",
255+
"county": "",
256+
"last_updated": "2020-03-23T13:32:23.913872Z",
257+
"coordinates": {
258+
"latitude": "43",
259+
"longitude": "12"
260+
},
261+
"latest": {
262+
"confirmed": 59138,
263+
"deaths": 5476,
264+
"recovered": 7024
265+
}
266+
}
267+
]
265268
}
266269
```
267270

0 commit comments

Comments
 (0)