Kotlin Multiplatform Ktor client for the MOTIS routing API, as deployed by Transitous.
The client is generated from the MOTIS v2.10.2 OpenAPI specification
(src/commonMain/openapi/motis.yaml) with
openapi-ktor-client-generator.
| Platform | Targets |
|---|---|
| JVM | jvm |
| Web | js (browser, Node.js), wasmJs (browser, Node.js) |
| Native | linuxX64, macosArm64, iosArm64, iosSimulatorArm64 |
// build.gradle.kts
kotlin {
sourceSets {
commonMain.dependencies {
implementation("org.litote:motis-ktor-client:<version>")
// the library does not impose an HTTP engine: add one
implementation("io.ktor:ktor-client-engine-defaults:3.6.0")
}
}
}ktor-client-engine-defaults selects an engine for each platform (OkHttp on the JVM, Curl on Linux,
Darwin on Apple platforms, Js on the web). You can instead add a specific engine dependency
and pass it with the engine parameter of motisClientConfiguration.
val configuration =
motisClientConfiguration(
applicationName = "MyApp",
applicationVersion = "1.2.0",
contact = "https://myapp.example",
)The Transitous usage policy requires every request to send a User-Agent
header containing the application name, the application version and a way of contact (e-mail address
or website URL). motisClientConfiguration builds it, followed by the library identifier:
User-Agent: MyApp/1.2.0 (+https://myapp.example) motis-ktor-client/<version> (+https://github.com/Litote/motis-ktor-client)
In a browser, the User-Agent header cannot be overridden: Transitous accepts the Referer header instead,
provided your website displays contact information.
Other parameters: baseUrl (default https://api.transitous.org/), logLevel (Ktor logging level,
default NONE) and engine.
One client per API tag, all sharing the same configuration:
| Client | Operations |
|---|---|
RoutingClient |
plan, oneToMany, oneToManyPost, oneToManyIntermodal, oneToManyIntermodalPost, oneToAll |
GeocodeClient |
geocode, reverseGeocode |
TimetableClient |
trip, refreshItinerary, refreshItineraryPost, stoptimes |
MapClient |
trips, initial, stops, levels, routes, routeDetails, rentals |
DebugClient |
transfers |
Client |
health |
Each operation returns a sealed class: …ResponseSuccess (typed body), …ResponseFailure
(documented error body) or …ResponseUnknownFailure (other status code or exception).
Response headers are available on every case.
val geocode = GeocodeClient(configuration)
val routing = RoutingClient(configuration)
suspend fun stopId(text: String): String? =
when (val response = geocode.geocode(text = text, type = listOf(LocationType.STOP), numResults = 1)) {
is GeocodeClient.GeocodeResponseSuccess -> response.body.firstOrNull()?.id
else -> null
}
val from = stopId("Paris Gare de Lyon") ?: error("not found")
val to = stopId("Lyon Part-Dieu") ?: error("not found")
when (
val plan =
routing.plan(
fromPlace = from,
toPlace = to,
time = Clock.System.now(),
transitModes = listOf(Mode.HIGHSPEED_RAIL, Mode.LONG_DISTANCE),
maxTransfers = 2,
)
) {
is RoutingClient.PlanResponseSuccess -> {
plan.body.itineraries.forEach { itinerary ->
println("${itinerary.startTime} -> ${itinerary.endTime}, ${itinerary.transfers} transfer(s)")
}
// next page
// routing.plan(fromPlace = from, toPlace = to, pageCursor = plan.body.nextPageCursor)
}
is RoutingClient.PlanResponseFailure -> println("error: ${plan.body.error}")
is RoutingClient.PlanResponseUnknownFailure -> println("HTTP ${plan.statusCode}")
}Dates are kotlin.time.Instant. Enums include an UNKNOWN_ value, so values added to the API later
do not break deserialization.
See CONTRIBUTING.md to build, test and release the project.
This project is licensed under the Apache License 2.0.
The OpenAPI specification src/commonMain/openapi/motis.yaml comes from the
MOTIS project and is distributed under the
MIT License.