db-rest/readme.md
2020-05-01 20:13:45 +02:00

2.1 KiB
Raw Blame History

db-rest

A clean REST API wrapping around the Deutsche Bahn HAFAS API. It is deployed at v5.db.transport.rest.

API Documentation | Why?

db-rest architecture diagram

Docker build status dependency status ISC-licensed gitter channel support me on Patreon

installing & running

via Docker

A Docker image is available as derhuerst/db-rest:5.

docker run -d -p 3000:3000 derhuerst/db-rest:5

manually

git clone https://github.com/derhuerst/db-rest.git
cd db-rest
git checkout 5
npm install --production
npm start

To keep the API running permanently, use tools like forever or systemd.

  • vbb-rest  A clean REST API wrapping around the VBB API.
  • bvg-rest  A clean REST API wrapping around the BVG API.
  • hvv-rest  A clean REST API wrapping around the HVV API.
  • hafas-rest-api  Expose a HAFAS client via an HTTP REST API.
  • hafas-client  JavaScript client for HAFAS public transport APIs.

Contributing

If you have a question, found a bug or want to propose a feature, have a look at the issues page.