Skip to content

eduayuso/konet

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
img
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Konet

GitHub license Download kotlin-version

Konet is a Kotlin MultiPlatform library (iOS & Android) that provides a network abstraction layer to request APIs over HTTP easily, so like other libraries as Retrofit (Android) or Alamofire (iOS). This library is a wrapper over ktor-client that make easier to use the ktor client features, and letting you to customize the logging, http interceptos and all other Ktor features if you need something more advanced than the default Konet configuration.

The Konet library has been built using the network utils library of moko-network. Moko-network, by IceRock is a useful Kotlin mpp library that includes an API client source generator from an OpenAPI specification using Swagger (the generator feature is not included in Konet)

Note: I encourage you to built your multiplatform solution using the moko-template, which comes along with a lot of very useful libs and utils to develop modular and scalable Kotlin multiplatform projects.

Table of Contents

Installation

root build.gradle

buildscript {
    repositories {
        maven { url = "https://dl.bintray.com/eduayuso/kolibs" }
    }

    dependencies {
        classpath "dev.eduayuso.kolibs:konet:1.1.1"
    }
}

allprojects {
    repositories {
        maven { url = "https://dl.bintray.com/eduayuso/kolibs" }
    }
}

Usage

Basic example: How to make a request to a fake API https://reqres.in/ in a MVVM / MVP project using Kotlin coroutines.

1.- Create your API client. You can create this property inside a SharedFactory class in your mpp-library
val sampleApi by lazy {

    DefaultKoApiClient(
        baseUrl = "https://reqres.in/api/"
    )
}

(You also can use the abstract class KoApiClient to define a custom Api with more options - see sample app sources)

2.- Create your Repository. (We recommend to use the repository pattern - more details in sample sources)
interface IUsersRepository {
   
   suspend fun getUserById(id:Int): UserModel?
}
class UsersRepository(api:KoApiClient): IUsersRepository {
    
    /** 
     * This makes a GET request to: https://reqres.in/users/{id}.
     * We need to provide the model serializer to the response resolver
     */
    override suspend fun getUserById(id:Int): UserModel? {
        
        return api.consume("users").get(id).response(UserModel.serializer())
    }
}
@Serializable
data class UserModel(
   var id: Int?,
   var email: String?
)
3.- Use the UsersRepository in your viewModel to consume the API and present the results
class UsersViewModel(
    
    val userRepo: IUsersRepository // implementation is injected

): ViewModel() {

    fun onFetchUserClick(id:Int) {
    
        viewModelScope.launch {
            try {
                val user = userRepo.getUserById(id)
                // present your user entity
            } catch (error: Exception) {
                // catch and present the error
            }
        }
    }
}
Notes:
  • In /sample folder in sources you can see a sample app for Android and for iOS
  • To run the iOS sample app you need to run 'pod install' inside the /sample/ios-app folder, after a successful build you can open the project by selecting the 'xcworkspace' file.

License

Copyright 2020 Eduardo Rodriguez Ayuso

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

Kotlin multiplatform network library

Resources

License

Stars

Watchers

Forks

Packages

No packages published