No description
Find a file
2022-12-21 14:48:06 +01:00
.github/workflows Node 18+ 💥💚 2022-12-21 14:47:58 +01:00
docs gitignore /docs/api.md 2022-12-21 14:48:06 +01:00
lib convert to ESM 💥 2022-12-21 14:47:58 +01:00
routes convert to ESM 💥 2022-12-21 14:47:58 +01:00
test convert to ESM 💥 2022-12-21 14:47:58 +01:00
.dockerignore minor changes 2019-03-27 12:22:48 +01:00
.editorconfig init from vbb-rest 2017-10-24 23:28:12 +02:00
.eslintrc.json convert to ESM 💥 2022-12-21 14:47:58 +01:00
.gitignore gitignore /docs/api.md 2022-12-21 14:48:06 +01:00
api-docs.js convert to ESM 💥 2022-12-21 14:47:58 +01:00
api.js convert to ESM 💥 2022-12-21 14:47:58 +01:00
architecture.svg prepare for v6 📝💚 2022-12-21 14:47:58 +01:00
Dockerfile Node 18+ 💥💚 2022-12-21 14:47:58 +01:00
index.js convert to ESM 💥 2022-12-21 14:47:58 +01:00
license.md minor tweaks 📝; 5.0.2 2022-11-22 16:07:57 +01:00
package.json convert to ESM 💥 2022-12-21 14:47:58 +01:00
readme.md prepare for v6 📝💚 2022-12-21 14:47:58 +01:00

db-rest

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

API Documentation

db-rest architecture diagram

API status dependency status ISC-licensed support me via GitHub Sponsors chat with me on Twitter

installing & running

db-rest expects a Redis server running on 127.0.0.1:6379 (default port), but you can set the REDIS_URL environment variable to change this.

via Docker

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

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

Note: The Docker image does not contain the Redis server.

manually

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

redis-server &
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.