No description
.github/workflows | ||
docs | ||
lib | ||
routes | ||
.dockerignore | ||
.editorconfig | ||
.gitignore | ||
api-docs.js | ||
api.js | ||
architecture.svg | ||
Dockerfile | ||
index.js | ||
license.md | ||
package.json | ||
readme.md |
db-rest
A clean REST API wrapping around the Deutsche Bahn HAFAS API. It is deployed at v5.db.transport.rest
.
installing & running
bvg-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:5
.
docker run -d -p 3000:3000 derhuerst/db-rest:5
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 5
npm install --production
redis-server &
npm start
To keep the API running permanently, use tools like forever
or systemd
.
Related Projects
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.