No description
291006c81e
Bumps [express](https://github.com/expressjs/express) from 4.18.2 to 4.19.2. - [Release notes](https://github.com/expressjs/express/releases) - [Changelog](https://github.com/expressjs/express/blob/master/History.md) - [Commits](https://github.com/expressjs/express/compare/4.18.2...4.19.2) --- updated-dependencies: - dependency-name: express dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> |
||
|---|---|---|
| .github | ||
| build | ||
| docs | ||
| lib | ||
| routes | ||
| test | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintrc.json | ||
| .gitignore | ||
| api.js | ||
| architecture.svg | ||
| Dockerfile | ||
| index.js | ||
| license.md | ||
| package-lock.json | ||
| package.json | ||
| readme.md | ||
db-rest
A clean REST API wrapping around the Deutsche Bahn HAFAS API. It is deployed at v6.db.transport.rest.
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.
Related Projects
DB-Adapter-v6– A Java API client fordb-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.