swapi-kmp
0.1.0indexedWraps the Star Wars API, offering an intuitive interface for accessing SWAPI data. Supports configuring network settings and provides expanded models for improved UI display.
0
Stars
—
Used by
dependents
—
Health
/ 100
SWAPI KMP
This is a Kotlin Multiplatform library that wraps the Star Wars API. It provides a simple and easy-to-use interface to interact with the SWAPI data.
The main purpose is to provide an easy way to show some data in a playground or PoC app, like a Compose Multiplatform app.
Supported platfroms:
- Android
- iOS
- JVM
- Wasm browser
Installation
repositories {
mavenCentral()
}
// in your commonMain sourceset
dependencies {
implementation("io.github.syex:swapi:$version")
}
Usage
The main class is the StarWarsApiClient. You get an instance via StarWarsApiClient.create().
val client = StarWarsApiClient.create()
The create() method optionally takes a lambda that has a StarWarsAPIClientConfig as its
receiver,
which allows you to tweak some settings of the Ktor client, which is used to make the network calls.
If you leave it the following defaults will be used:
data class StarWarsAPIClientConfig(
var httpClientEngine: HttpClientEngine? = null,
connectTimeoutMs: = ,
requestTimeoutMs: = ,
socketTimeoutMs: = ,
jsonConfig: Json = Json {
prettyPrint =
isLenient =
ignoreUnknownKeys =
explicitNulls =
},
additionalConfig: HttpClientConfig<*>.() -> = {},
)
e.g.
val client = StarWarsApiClient.create {
connectTimeoutMs = 5_000L
}
StarWarsApiClient
The Star Wars API provides six different kind of endpoints, which the library maps as following:
- ->
The StarWarsApiClient provides the same set of methods for each endpoint, e.g. for /starships:
fun searchStarships(query: String): PagedResponse<StarshipApiModel>fun getAllStarships(pageUrl: String? = null): PagedResponse<StarshipApiModel>fun getStarshipByUrl(url: String): StarshipApiModelfun getExpandedStarshipByUrl(url: String): ExpandedStarshipApiModel
The getAll*() methods take an optional page url, which should be the value of PagedResponse.next
if you want to load the next page of the initial response.
Expanded models
The StarWarsApiClient has methods to get an extended model next to the normal API response. This
is a concept this library introduced so it's easier to display responses in a UI.
The SWAPI contains any references, like the starships and films of a person, as hyperlinks. An extended model did an additional round of network requests to resolve all of these hyperlinks once.
So instead of returning a PeopleApiModel with a list of starship and film URLs, you would get a
ExpandedPeopleApiModel which contains the same data plus the resolved StarshipApiModels and
FilmApiModels.