Merge pull request #143 from Kilo59/FastAPI-conversion

FastAPI conversion

Author: ExpDev07

Pipfile

@@ -9,13 +9,19 @@ pytest = "*"
 pylint = "*"
 
 [packages]
+fastapi = "*"
 flask = "*"
 python-dotenv = "*"
 requests = "*"
 gunicorn = "*"
 flask-cors = "*"
 cachetools = "*"
 python-dateutil = "*"
+uvicorn = "*"
 
 [requires]
 python_version = "3.8"
+
+[scripts]
+dev = "uvicorn app.main:APP --reload"
+start = "uvicorn app.main:APP"

Pipfile.lock

@@ -1 +1 @@
-web: gunicorn app:create_app\(\)
+web: gunicorn app.main:APP -k uvicorn.workers.UvicornWorker

Procfile

@@ -46,6 +46,13 @@ You can open the URL in your browser to further inspect the response. Or you can
 curl https://coronavirus-tracker-api.herokuapp.com/v2/locations | json_pp
 ```
 
+### Swagger/OpenAPI
+
+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).
+
+
+The [OpenAPI](https://swagger.io/docs/specification/about/) json definition can be downloaded at https://coronavirus-tracker-api.herokuapp.com/openapi.json
+
 ## API Endpoints 
 
 ### Sources Endpoint
@@ -122,6 +129,7 @@ __Sample response__
     "country": "Norway",
     "country_code": "NO",
     "province": "",
+    "county": "",
     "last_updated": "2020-03-21T06:59:11.315422Z",
     "coordinates": { },
     "latest": { },
@@ -166,6 +174,7 @@ __Sample response__
       "country": "Thailand",
       "country_code": "TH",
       "province": "",
+      "county": "",
       "last_updated": "2020-03-21T06:59:11.315422Z",
       "coordinates": {
         "latitude": "15",
@@ -182,6 +191,7 @@ __Sample response__
       "country": "Norway",
       "country_code": "NO",
       "province": "",
+      "county": "",
       "last_updated": "2020-03-21T06:59:11.315422Z",
       "coordinates": {
         "latitude": "60.472",
@@ -231,29 +241,30 @@ GET /v2/locations?country_code=IT
 __Sample Response__
 ```json
 {
-    "latest": {
-        "confirmed": 59138,
-        "deaths": 5476,
-        "recovered": 7024
-    },
-    "locations": [
-        {
-            "coordinates": {
-                "latitude": "43",
-                "longitude": "12"
-            },
-            "country": "Italy",
-            "country_code": "IT",
-            "id": 16,
-            "last_updated": "2020-03-23T13:32:23.913872Z",
-            "latest": {
-                "confirmed": 59138,
-                "deaths": 5476,
-                "recovered": 7024
-            },
-            "province": ""
-        }
-    ]
+  "latest": {
+    "confirmed": 59138,
+    "deaths": 5476,
+    "recovered": 7024
+  },
+  "locations": [
+    {
+      "id": 16,
+      "country": "Italy",
+      "country_code": "IT",
+      "province": "",
+      "county": "",
+      "last_updated": "2020-03-23T13:32:23.913872Z",
+      "coordinates": {
+          "latitude": "43",
+          "longitude": "12"
+      },
+      "latest": {
+          "confirmed": 59138,
+          "deaths": 5476,
+          "recovered": 7024
+      }
+    }
+  ]
 }
 ```
 
@@ -385,7 +396,7 @@ You will need the following things properly installed on your computer.
 
 ## Running / Development
 
-* `flask run`
+* `pipenv run dev`
 * Visit your app at [http://localhost:5000](http://localhost:5000).
 
 ### Running Tests