Lamassu

Mobility aggregation service based on the General Bikeshare Feed Specification (GBFS) v2.2.

Configuration

resources/feedproviders.yml lists GBFS feeds which will be polled by this application:

    lamassu:
        providers:
          - systemId: mysystem
            operatorId: MFM:Operator:myoperator
            operatorName: My operator
            codespace: MFM
            url: https://myfavoritegbfsfeeed.com/gbfs.json
            language: en

This will use the GBFS auto-discovery at url and poll en language feeds.

NOTE: codespace is relevant when aggregating entities across systems, to avoid conflicts between IDs. Every ID (except systemId, which (by GBFS convention) should already be globally unique) is prefixed by this codespace. At least every operator should be assigned its own unique codespace, assuming operators already maintain data / ID separation accross their feeds. The codespaced operatorId should comply with the following format <codespace>:Operator:<operator>.

End-points

/gbfs

List all GBFS feeds available via this API

/gbfs/{system}/{feed}

GBFS feeds for a specific feed system:

E.g.

/gbfs/boltoslo/free_bike_status

will return the free_bike_status feed for Bolt's scooter service in Oslo.

/graphql

GraphQL endpoint targeted at end-user clients. Documentation can be explored at /graphiql.

Development

Requires a locally running redis instance. E.g.:

docker run -p 127.0.0.1:6379:6379 -d redis redis-server