README.md

CovidInfo.RestAPI

RESTful microservice for gathering and sharing COVID-19 related data in Poland.
API fetches data from "COVID-19 w Polsce" Google Spreadsheet created and maintained by Michał Rogalski

Table of Contents

1. About The Project
   • Example usage
   • Built With
   • Features
   • RestAPI Endpoints
2. Getting Started
   • Prerequisites
   • Installation
   • Report Issues
3. Contact
4. Acknowledgements

About The Project

Example usage

API can be tested with following Kotlin App

Built With

• ASP.NET Web API
• Entity Framework 6
• ExcelDataReader
• Newtonsoft.Json

Features

• Access to Covid-19 related data for country and regions through RestAPI
• Automatic fetching from COVID-19 w Polsce Google Spreadsheet
• Storing data on a SQL Server
• News channel

RestAPI Endpoints

Get country list

GET /api/country/list

Get regions list for selected country

GET /api/region/{countryId}/list

Get all regions summary for today

GET /api/region/{countryId}/summary

Get all entries for selected country/region

GET /api/country/{countryId}
GET /api/region/{countryId}/{regionId}

Get latest single entry for selected country/region

GET /api/country/{countryId}/today
GET /api/region/{countryId}/{regionId}/day/{date}

Get entry for selected day

GET api/country/{countryId}/day/{date}
GET api/region/{countryId}/{regionId}/today

Get all entries since selected day

GET api/country/{countryId}/since/{date}
GET api/region/{countryId}/{regionId}/since/{date}

Get number of news pages

GET /api/country/{countryId}/news/pages

Get news from selected page (10 news per page)

GET /api/country/{countryId}/news/{page}

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To build this project, you require:

• Visual Studio 2019
• IIS Express

Installation

1. Clone the repo

   git clone https://github.com/czubamich/CovidInfo.RestAPI.git

2. Open project in Vistual Studio.
3. Setup SQL database (PolandDatbaseQuery.sql)
4. Run 'app' F5.

Report issues

If you find anything that is performing not as espected? Any feature that should be added or improved? Please feel free to check the issue tracked and create create a ticket. Please try to provide a detailed description of your problem, including the steps to reproduce it.

Contact

Michael Czuba - [email protected]

Acknowledgements

• COVID-19 w Polsce by Michał Rogalski