Coronavirus Tg API

You can open the URL in your browser to further inspect the response. Or you can make this curl call in your terminal to see the prettified response:

<pre><code class="lang-">curl https://coronavirus-tg-api.herokuapp.com/v1/cases | json_pp</code></pre>

Swagger/OpenAPI

Consume our API through our super awesome and interactive SwaggerUI (on mobile, use the mobile friendly ReDocs instead for the best experience).

The OpenAPI json definition can be downloaded at https://coronavirus-tg-api.herokuapp.com/openapi.json

Technologies used for the project

• Python3.8 / FastApi / Unicorn / => Language & Framework
• Docker & Docker Compose => Dockerization
• Heroku => Hosting
• Travis => Build,Test, deploy, … (Github Actions soon)
• Telegram API => Bot to receive Travis job result instead of email notification

API Endpoints

Cases Endpoint

Getting total of confirmed cases, deaths, recovered and the last updated date.

<pre><code class="lang-http">GET /v1/cases</code></pre>

Sample response <pre><code class="lang-json">{ &quot;confirmed&quot;: 99, &quot;recovered&quot;: 62, &quot;deaths&quot;: 6, &quot;last_updated&quot;: &quot;2020-04-27 11:12:00&quot; }</code></pre>

Sources Endpoint

Getting the data-sources that are currently available to Coronavirus Tg API to retrieve the data of the pandemic. Currently,the government website and the tracker api project.

<pre><code class="lang-http">GET /v1/sources</code></pre>

Sample response <pre><code class="lang-json">{ &quot;government_website&quot;: &quot;https://covid19.gouv.tg&quot;, &quot;trackerapiproject&quot;: &quot;https://github.com/egbakou/coronavirus-tg-api&quot; }</code></pre>

Confirmed cases Endpoint

Getting confirmed cases data.

<pre><code class="lang-http">GET /v1/cases/confirmed</code></pre>

Sample response

<pre><code class="lang-json">{ &quot;confirmed&quot;: 99, &quot;last_updated&quot;: &quot;2020-04-27 11:12:00&quot; }</code></pre>

Recovered cases Endpoint

Getting recovered cases data.

<pre><code class="lang-http">GET /v1/cases/recovered</code></pre>

Sample response

<pre><code class="lang-json">{ &quot;recovered&quot;: 62, &quot;last_updated&quot;: &quot;2020-04-27 11:12:00&quot; }</code></pre>

Deaths data Endpoint

Getting number of deaths.

<pre><code class="lang-http">GET /v1/cases/deaths</code></pre>

Sample response

<pre><code class="lang-json">{ &quot;deaths&quot;: 6, &quot;last_updated&quot;: &quot;2020-04-27 11:12:00&quot; }</code></pre>

Response definitions

| Response Item | Description | Type | | ----------------- | ------------------------------------------------------------ | -------- | | {cases} | total of confirmed cases, deaths, recovered and the last updated date. | Object | | {cases}/confirmed | The up-to-date total number of confirmed cases | Integer | | {cases}/deaths | The up-to-date total number of deaths | Integer | | {cases}/recovered | The up-to-date total number of recovered | Integer | | {sources} | Data-sources used to provide data | Object |

> We strongly recommend using the endpoint /v1/cases instead of using the endpoints returning each case.

Wrappers

No wrapper at the moment.

Prerequisites

You will need the following things properly installed on your computer.

• Python 3 (with pip)
• pipenv

Installation

Running / Development

For a live reloading on code changes.

Alternatively run our API with Docker.

Running Tests

<pre><code class="lang-bash">pipenv run test</code></pre>

Linting

<pre><code class="lang-bash">pipenv run lint</code></pre>

Formatting

<pre><code class="lang-bash">pipenv run fmt</code></pre>

Update requirements files

<pre><code class="lang-bash">invoke generate-reqs</code></pre>

Docker

Our Docker image is based on tiangolo/uvicorn-gunicorn-fastapi/.

<pre><code class="lang-bash">invoke docker --build</code></pre>

Alternate Docker images

Invoke