EasyWebservice

General

Category
Free
Tag
REST
License
N/A
Min SDK
4 (Android 1.6 Donut)
Registered
Sep 14, 2018
Favorites
2
Link
https://github.com/ashkanpower/EasyWebservice
See also
SimpleRestClientHelper
jus
VolleyBall
Broker
android-rest-client

Additional

Language
Java
Version
N/A
Created
Sep 10, 2018
Updated
May 6, 2019
Owner
ashkan power (ashkanpower)
Contributor
ashkan power (ashkanpower)
1
Activity
Badge
Generate
Download
Source code
APK file

Commercial

EasyWebservice

Fast and easy RESTful api calls for android. If using Retrofit is hard, or you are tired of handling json responses, this library is for you.

How to use

Add jitpack to repositories

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

then add library to dependencies

dependencies {
   implementation 'com.github.ashkanpower:easywebservice:b5f5874cb0'
 }

Fast useage

response :

  {res : true, msg : "success"}

code :

  new EasyWebservice("http://host.com/api/v1/test")
 .method(Method.POST) //default
 .addHeader("token", "your_token_hear")
        .addParam("id", 100) //adding params to body
        .call(new Callback.AB<Boolean, String>("res", "msg") { //should map response params
  @Override
  public void onSuccess(Boolean res, String msg) {
          
                        //you can work with res and msg which are in json response
  }

         @Override
  public void onError(String error) {
          
                        //if any error encountered
  }
 });

Object usage

If you have object in your response you should define that object

response :

  { thePerson : {id:10, name : "ashkan", lastname : "power"} }

code :

//define your class with the same attributes as the JSON response
public class Person {
  int id; 
  String name;
  String lastname;
}

 new EasyWebservice("http://host.com/api/v1/person")
     .call(new Callback.A<Person>("thePerson") { //should map response params
      @Override
      public void onSuccess(Person person) {
        
                 //the person object filled with response info
      }

      @Override
      public void onError(String error) {
        
                  //if any error encountered
      }
     });

note : The class must be accessible by gson library. And also your proguard-rules should not change classes and attributes name. it is needed by gson library.

array responses

EasyWebservice also handles array responses

response :

["California", "New York", "LA", "Texas"]

code :

new EasyWebservice("http://host.com/api/v1/cities")
    .call(new Callback.A<ArrayList<String>>() { //the mapping for root elements should be empty
     @Override
     public void onSuccess(ArrayList<String> cities) {
          
                   //work with the array
     }

     @Override
     public void onError(String error) {
          
                    //if any error encountered
     }
    });

It can easily be also an array of custom objects like this.

response :

[{id:10, name : "ashkan", lastname : "power"},
{id:10, name : "ashkan", lastname : "power"},
{id:10, name : "ashkan", lastname : "power"} ]

code :

class Person {
    int id; //the same as object
    String name;
    String lastname;
  }

new EasyWebservice("http://host.com/api/v1/cities")
    .call(new Callback.A<ArrayList<Person>>() { //the mapping for root elements should be empty
     @Override
     public void onSuccess(ArrayList<Person> people) {
          
                   //work with the array
     }

     @Override
     public void onError(String error) {
          
                    //if any error encountered
     }
    });

Testing phase

If you are coding your app but your webserver is not ready yet, you can use and test your app with easyWebservice. You can use fakeJSON to test your code like this: note : Just remember to delete the fakejson after your server is ready.

response :

  {res : true, msg : "success"}

code :

  new EasyWebservice("http://host.com/api/v1/test")
 .addHeader("token", "your_token_hear")
        .addParam("id", 100) //adding params to body
 .fakeJson("{res : true, msg : \"success\"}") //this is the fake response
 .fakeJsonDelay(2000, 5000) // this is the random delay you are expecting your connection needs in milisecs
        .call(new Callback.AB<Boolean, String>("res", "msg") { //should map response params
  @Override
  public void onSuccess(Boolean res, String msg) {
          
                        //you can work with res and msg which are in json response
  }

         @Override
  public void onError(String error) {
          
                        //if any error encountered
  }
 });

More info

The callback group has 5 levels

Callback.A
Callback.AB
Callback.ABC
Callback.ABCD
Callback.ABCDE

which allows you to get JSON response up to 5 root attributes. the combination will be unlimited.

note : If you have more than 5 attributes, you should define a response class specified to that json;