journeys-api

Journeys API serves GTFS data as JSON. This project was originally created for City of Tampere, but is now open sourced. You can find more information about the project in the ITS Factory Wiki, where the current closed source API is discussed. This open source version of the API tries to match the proprietary version as much as possible.

Running the server

First, download the dependencies:

go mod download

Start the server:

go run cmd/journeys/journeys.go

The command reads following environment variables:

argument	explanation
JOURNEYS_GTFS_PATH	path to directory where the GTFS files are located
JOURNEYS_BASE_URL	the base of the outputted URLs in responses
JOURNEYS_VA_BASE_URL	the base of the outputted vehicle activity URLs in responses
JOURNEYS_PORT	the port where the service will run. defaults to 8080

The GTFS files for the Tampere region can be downloaded from ITS Factory. We currently use the Tampere GTFS files for development, but you should be able to use other cities' GTFS files as well.

There is also a Makefile command which uses defaults for the environment variables:

# Run the server with the default development environment variables (localhost for internal URL links)
make tre-dev
# Run the server with the default development environment variables (data.itsfactory.fi for internal URL links)
make tre

Using the Makefile is not required, you can run the server with go command and set the environment variables manually.

Updating module versions

1. Update the version of the package in the go.mod file
2. Run go get -u <package-name> to update the package

Endpoint compatibility

You should expect endpoint compatibility with the proprietary Journeys API according to the following table:

Endpoint	Status	Notes
/lines	Fully compatible	-
/routes	Fully compatible	-
/journey-patterns	Fully compatible	-
/journeys	Fully compatible	-
/stop-points	Fully compatible	-
/municipalities	Fully compatible	-
/lines/:lineId	Fully compatible	-
/routes/:routeId	Fully compatible	-
/journey-patterns/:journeyPatternId	Fully compatible	-
/journeys/:journeyId	Fully compatible	-
/stop-points/:stopPointId	Fully compatible	-
/municipalities/:municipalityId	Fully compatible	-
/vehicle-activity	n/a	Not supported currently
/stop-monitoring	n/a	Not supported currently
/files/gtfs	n/a	Not supported currently

Please note:

• You should not expect the response object properties to be in the same order as in the proprietary API
• You should not expect the response array items to be in the same order as in the proprietary API
• You should not expect the response page sizes to match the proprietary API. We aim to return all items in one page, however the paging information is maintained for backwards compatibility