Facilitates network operations by generating API classes and entities from OpenAPI specifications, supports token-based authentication, error handling, and token refreshment, enhancing networking capabilities.
This is a Kotlin MultiPlatform library that provide network components for iOS & Android. Library is addition to ktor-client with gradle plugin to generate entities and api classes from OpenAPI (Swagger) specification file. Entities serialization done by kotlinx.serialization.
root build.gradle
buildscript {
repositories {
gradlePluginPortal()
}
dependencies {
classpath "dev.icerock.moko:network-generator:0.23.0"
}
}
allprojects {
repositories {
mavenCentral()
}
}
project build.gradle
apply plugin: "dev.icerock.mobile.multiplatform-network-generator"
dependencies {
commonMainApi("dev.icerock.moko:network:0.23.0")
commonMainApi("dev.icerock.moko:network-engine:0.23.0") // configured HttpClientEngine
commonMainApi("dev.icerock.moko:network-bignum:0.23.0") // kbignum serializer
commonMainApi("dev.icerock.moko:network-errors:0.23.0") // moko-errors integration
}
E.g. put an OpenAPI Specification file to src/swagger.json path of the project Gradle module.
Setup the project build.gradle:
mokoNetwork {
spec("pets") {
inputSpec = file("src/swagger.json")
}
spec("news") {
inputSpec = file("src/newsApi.yaml")
packageName = "news"
isInternal = false
isOpen = true
configureTask {
// here can be configuration of https://github.com/OpenAPITools/openapi-generator GenerateTask
}
enumFallbackNull = false
}
}
Then run openApiGenerate Gradle task and after completion you will get all generated classes in
build/generated/moko-network directory.
To import all generated classes of model put:
import dev.icerock.moko.network.generated.models.*
import dev.icerock.moko.network.generated.apis.*
import dev.icerock.moko.network.generated.apis.*
class TestViewModel : ViewModel() {
petApi = PetApi(
basePath = ,
httpClient = ktorHttpClient,
json = kotlinxJsonParser
)
{
viewModelScope.launch {
{
pet = petApi.findPetsByStatus(listOf())
} (error: Exception) {
}
}
}
}
For the moko-network specification generator, you can enable safe enum properties generation mode.
To turn on the mode in build.gradle to a spec block add flag:
enumFallbackNull = true
The enabled mode will generate special wrapper Safeable for all properties with the enum type,
that which in a situation for an unexpected enum value will return null.
Old way with OpenApi Generator Plugin available by:
apply plugin: "dev.icerock.mobile.multiplatform-network-generator-deprecated"
openApiGenerate {
inputSpec.set(file("src/swagger.json").path)
generatorName.set("kotlin-ktor-client")
}
but this way limited to one spec in one time.
There is module moko-network-errors for moko-errors
library that contains built-in mappers for mapping moko-network exception classes into
StringDesc objects (there are built-in resources for text in English and Russian).
To use the moko-network-errors module just call the registerAllNetworkMappers extension of
ExceptionMappersStorage object:
fun initExceptionMappersStorage() {
ExceptionMappersStorage.registerAllNetworkMappers()
}
And then you can use ExceptionHandler to automatically handle exceptions for network requests:
viewModelScope.launch {
exceptionHandler.handle {
val pet = petApi.findPetsByStatus(listOf("available"))
// ...
}.execute()
}
You can override standard error messages (which are localized in English and Russian by default) by passing your own NetworkErrorsTexts object. This allows you to customize messages for HTTP errors, SSL issues, serialization failures, and set a fallback defaultErrorText.
Usage example:
For more information about exception handling see moko-errors.
More examples can be found in the sample directory.
network library;network-errors module;All development (both new features and bug fixes) is performed in develop branch. This way master sources always contain sources of the most recently released version. Please send PRs with bug fixes to develop branch. Fixes to documentation in markdown files are an exception to this rule. They are updated directly in master.
The develop branch is pushed to master during release.
More detailed guide for contributers see in contributing guide.
Copyright 2019 IceRock MAG Inc
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
// 1. Define HTTP specific errors
private val httpNetworkErrorsTexts = HttpNetworkErrorsTexts(
unauthorizedErrorText = MR.strings.unauthorizedErrorText,
notFoundErrorText = MR.strings.notFoundErrorText,
accessDeniedErrorText = MR.strings.accessDeniedErrorText,
internalServerErrorText = MR.strings.internalServerErrorText
)
// 2. Define SSL specific errors
private val sslNetworkErrorsTexts = SSLNetworkErrorsTexts(
secureConnectionFailed = MR.strings.secureConnectionFailedText,
serverCertificateHasBadDate = MR.strings.serverCertificateHasBadDateText,
serverCertificateUntrusted = MR.strings.serverCertificateUntrustedText,
serverCertificateHasUnknownRoot = MR.strings.serverCertificateHasUnknownRootText,
serverCertificateNotYetValid = MR.strings.serverCertificateNotYetValidText,
clientCertificateRejected = MR.strings.clientCertificateRejectedText,
clientCertificateRequired = MR.strings.clientCertificateRequiredText,
cannotLoadFromNetwork = MR.strings.cannotLoadFromNetworkText
)
// 3. Assemble all texts including general network errors and default fallback
private val networkErrorsTexts = NetworkErrorsTexts(
networkConnectionErrorText = MR.strings.networkConnectionErrorText,
serializationErrorText = MR.strings.serializationErrorText,
httpNetworkErrorsTexts = httpNetworkErrorsTexts,
sslNetworkErrorsTexts = sslNetworkErrorsTexts,
defaultErrorText = MR.strings.defaultErrorText // Fallback for undefined errors
)
// 4. Register mappers with your custom texts
fun initExceptionMappersStorage() {
ExceptionMappersStorage.registerAllNetworkMappers(
errorsTexts = networkErrorsTexts
)
}
Surfaced from shared tags and platforms — no rankings paid for.