No description
Find a file
dependabot[bot] e8b040e601 Bump follow-redirects from 1.15.5 to 1.15.6
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.5 to 1.15.6.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.5...v1.15.6)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-03-17 16:06:48 +01:00
.github CI: publish with "floating" Docker image tag too 💚 2024-01-25 14:49:41 +01:00
build API docs: minor fix 📝 2024-01-25 14:48:16 +01:00
docs docs: fix status page link/badge, other tweaks 📝; 6.0.1 2023-05-08 14:58:13 +02:00
lib db-stations@5, db-stations-autocomplete@4 2022-12-28 14:22:28 +01:00
routes db-stations@5, db-stations-autocomplete@4 2022-12-28 14:22:28 +01:00
test adapt tests to latest data 2022-12-28 14:22:28 +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 check in package-lock.json, adapt Dockerfile & CI config 💚 2023-09-06 14:41:51 +02:00
api.js docs: fix status page link/badge, other tweaks 📝; 6.0.1 2023-05-08 14:58:13 +02:00
architecture.svg prepare for v6 📝💚 2022-12-21 14:47:58 +01:00
Dockerfile check in package-lock.json, adapt Dockerfile & CI config 💚 2023-09-06 14:41:51 +02:00
index.js convert to ESM 💥 2022-12-21 14:47:58 +01:00
license.md API docs: minor fix 📝 2024-01-25 14:48:16 +01:00
package-lock.json Bump follow-redirects from 1.15.5 to 1.15.6 2024-03-17 16:06:48 +01:00
package.json minor-upgrade deps & dev deps; 6.0.4 2024-01-25 14:51:00 +01:00
readme.md readme: mention $REDIS_URL 📝 2024-01-26 17:38:20 +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

access to Redis

It is recommended that you let bvg-rest cache HAFAS responses within a Redis cache. To use this feature, set $REDIS_URL (e.g. to redis://localhost:6379/1 when running Redis locally).

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

export HOSTNAME='my-vbb-rest-api.example.org'
npm run build

redis-server &
npm start

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

  • DB-Adapter-v6 A Java API client for db-rest.
  • 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.