dan/covid
1
0
Fork 0
mirror of https://github.com/danbulant/covid synced 2026-05-19 03:48:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
covid/docs
History
Daniel Bulant d3976a5e55 Prepare for documentation of endpoints
2020-03-09 19:08:53 +01:00
..
ENDPOINTS.md Prepare for documentation of endpoints 2020-03-09 19:08:53 +01:00
README.md Prepare for documentation of endpoints 2020-03-09 19:08:53 +01:00
TYPES.md Add documentation 2020-03-09 18:49:15 +01:00

README.md

Documentation

Setting it up

  • Clone (either using git or hub) this repository
  • Install dependencies (npm i)
  • Run it! (npm start)

Format

Every response is in JSON and contains at least these fields:

  • code - HTTP status code
  • type - Type of response, see types
  • data - Might be missing, depends of type.

Endpoints

For list of endpoints, see ENDPOINTS.md