iq-scm / endpoint2mock2

Android library which simplifies mocking of Retrofit2 endpoints

Endpoint2mock2

Sometimes when working with REST APIs there is a need to return some mock data. Maybe for demo purposes, or real endpoint is just not ready yet. Endpoint2mock2 aims to help with that by integrating with Retrofit2 and allowing you to easily redirect some (but not all!) of your requests to your mock server.

Here is how it goes.

Retrofit 1

This library is working only with Retrofit 2. For Retrofit 1 use the other version of the library: https://github.com/car2go/Endpoint2mock

Add it to your project

Step one

Add jitpack.io to the list of your repositories.

repositories {
  maven { url 'https://jitpack.io' }
}

Step two

Add dependencies.

compile 'com.github.car2go.Endpoint2mock2:endpoint2mock2:1.1.0'

// If you use Kotlin
kapt 'com.github.car2go.Endpoint2mock2:endpoint2mock2-compiler:1.1.0'

// If you do not use Kotlin
annotationProcessor 'com.github.car2go.Endpoint2mock2:endpoint2mock2-compiler:1.1.0'

Step three

Add @MockedEndpoint annotation to your Retrofit interface. For the sake of example let's use Github API.

interface GithubApi {

    /**
     * Will call mocked server if MockableClient is enabled, and call the real server when it is not enabled.
     */
    @MockedEndpoint
    @GET("/users/car2go/repos")
    fun getCompanyRepositories(): Single<List<Repository>>

}

Step four

Use MockableClient as client for your Retrofit builder.

 val client = MockableClient.baseUrl(mockServerUrl)   // Assuming that you have something running at this URL
                         .mockWhen { mockToggle.isChecked } // Default is true
                         .build()

 val githubApi = Retrofit.Builder()
         .client(client)
         .baseUrl("https://api.github.com")
         .addConverterFactory(GsonConverterFactory.create())
         .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
         .build()
         .create(GithubApi::class.java)

You can check json-server folder for an example of mock server.

And you are ready to go!

Proguard

Just one line.

-keep class com.car2go.mock.FakeRegistry { *; }

License

Copyright 2017 car2go group GmbH

Released under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.