/homebird

Primary LanguagePython

HomeBird API

To run locally:

$ uvicorn app.main:app --reload --workers 1 --host 0.0.0.0 --port 8003

Note: The data is generated at runtime if and only if no data is detected in a local json file.

To refresh data:

  1. Delete homebird.json
  2. Re-deploy (locally or via server) to refresh homebird.json

To run tests:

$ pytest

URLs

Deployed at: homebird.herokuapp.com

Swagger Docs: homebird.herokuapp.com/docs

API Endpoints

GET

official client only /homebird/homes
official client only /homebird/homes-ids
official client only /homebird/homes/{home_id}

To DO:

POST

official client only /homebird/homes