add api mock

Author: BakerJQ

README.md

@@ -25,7 +25,7 @@ allprojects {
 Add the dependency
 ``` groovy
 dependencies {
-    implementation 'com.github.BakerJQ:RxRetroHttp:1.1.0'
+    implementation 'com.github.BakerJQ:RxRetroHttp:1.2.0'
 }
 
 ```
@@ -48,16 +48,19 @@ Mention:
 - You need to do this after you called init()
 - DON'T forget to add the 'Tag' in generateRetroClient() function
 - If you don't set an ApiResultClass, the lib will use GsonConverterFactory as default, this means that the lib will not deal with response logic for you, or you can add your own ResponseConverter
+
 ```java
 RxRetroHttp.getInstance()
            .setApiResultClass(YourApiResult.class)//other result
            .setBaseUrl("http://host/api/data/")//other url
            .generateRetroClient("YourTag");//other request tag
 ```
+
 #### Settings
 You can customize your http settings by get and reset the builders, or calling setting functions
 
 Mention: This must be done AFTER init() and BEFORE generateRetroClient() function
+
 ```java
 RxRetroHttp.init().setXXX().setXXX();
 Retrofit.Builder retrofitBuilder = RxRetroHttp.getRetrofitBuilder();
@@ -109,6 +112,45 @@ Just define a call like Retrofit
 ```java
 RxRetroHttp.create(YourApiService.class).getTestInfo()
 ```
+
+### Mock Data
+You can mock your api data in two ways: from file or from json string.
+
+You should enable mock when init;
+
+```java
+RxRetroHttp.init(this).setMockEnable(true)
+```
+
+#### Mock From File
+Step 1. Put your mock data file under assets dir
+
+Step 2. Add headers to your api function
+
+```java
+@Headers({RxRetroHttp.MOCK_FILE_PATH_KEY + ":mockfile.json")
+@GET("test/info")
+Observable<TestInfo> getTestInfo();
+```
+
+#### Mock From Json String
+Just add headers to your api function
+
+```java
+@Headers({RxRetroHttp.MOCK_DATA_KEY + ":{\"testInfo\":\"info\"}")
+@GET("test/info")
+Observable<TestInfo> getTestInfo();
+```
+
+#### Header Keys
+
+| key | desc |
+| ---- | ---- |
+| MOCK_DATA_KEY | mock json string |
+| MOCK_FILE_PATH_KEY | mock assets file path |
+| MOCK_ENABLE_KEY | enable or disable mock |
+| MOCK_DELAY_KEY | delay duration of response |
+
 ## Proguard
 - Add Retrofit proguard
 - Add OkHttp proguard
@@ -118,7 +160,7 @@ RxRetroHttp.create(YourApiService.class).getTestInfo()
 For 21- projects, add the dependency like below
 ``` groovy
 dependencies {
-    implementation ('com.github.BakerJQ:RxRetroHttp:1.1.0'){
+    implementation ('com.github.BakerJQ:RxRetroHttp:1.2.0'){
         exclude group: 'com.squareup.okhttp3', module: 'okhttp'
     }
     implementation 'com.squareup.okhttp3:okhttp:3.12.0'

README_cn.md

@@ -26,7 +26,7 @@ allprojects {
 在app或相应使用的module中加入
 ``` groovy
 dependencies {
-    implementation 'com.github.BakerJQ:RxRetroHttp:1.1.0'
+    implementation 'com.github.BakerJQ:RxRetroHttp:1.2.0'
 }
 
 ```
@@ -111,11 +111,49 @@ public interface YourApiService {
 RxRetroHttp.create(YourApiService.class).getTestInfo()
 ```
 
+### Mock数据
+你可以通过json字符串以及文件的方式进行mock。
+
+若要开启mock，请在初始化时进行设置。
+
+```java
+RxRetroHttp.init(this).setMockEnable(true)
+```
+
+#### 通过文件进行Mock
+Step 1. 将mock文件放到assets下
+
+Step 2. 对API方法增加Headers注解
+
+```java
+@Headers({RxRetroHttp.MOCK_FILE_PATH_KEY + ":mockfile.json")
+@GET("test/info")
+Observable<TestInfo> getTestInfo();
+```
+
+#### 通过Json字符串进行Mock
+直接添加Headers
+
+```java
+@Headers({RxRetroHttp.MOCK_DATA_KEY + ":{\"testInfo\":\"info\"}")
+@GET("test/info")
+Observable<TestInfo> getTestInfo();
+```
+
+#### 所支持的Header Key
+
+| key | 描述 |
+| ---- | ---- |
+| MOCK_DATA_KEY | mock json字符串 |
+| MOCK_FILE_PATH_KEY | mock assets文件路径 |
+| MOCK_ENABLE_KEY | 是否开启mock |
+| MOCK_DELAY_KEY | mock返回结果的延时 |
+
 ## Android API等级小于21
 对于Android API等级小于21的工程，按如下方式引入该库
 ``` groovy
 dependencies {
-    implementation ('com.github.BakerJQ:RxRetroHttp:1.1.0'){
+    implementation ('com.github.BakerJQ:RxRetroHttp:1.2.0'){
         exclude group: 'com.squareup.okhttp3', module: 'okhttp'
     }
     implementation 'com.squareup.okhttp3:okhttp:3.12.0'

app/src/main/assets/mock/weather.json

@@ -0,0 +1,91 @@
+{
+  "time": "2018-09-22 12:37:21",
+  "date": "20180922",
+  "message": "Success !",
+  "status": 200,
+  "data": {
+    "cityInfo": {
+      "city": "南昌市",
+      "parent": "江西",
+      "updateTime": "12:32"
+    },
+    "shidu": "22%",
+    "pm25": 15.0,
+    "pm10": 46.0,
+    "quality": "优",
+    "wendu": "24",
+    "ganmao": "各类人群可自由活动",
+    "forecast": [
+      {
+        "date": "22",
+        "ymd": "2018-09-22",
+        "week": "星期六",
+        "sunrise": "05:57",
+        "high": "高温 26.0℃",
+        "low": "低温 15.0℃",
+        "sunset": "18:10",
+        "aqi": 55.0,
+        "fx": "西北风",
+        "fl": "4-5级",
+        "type": "晴",
+        "notice": "愿你拥有比阳光明媚的心情"
+      },
+      {
+        "date": "23",
+        "ymd": "2018-09-22",
+        "week": "星期日",
+        "sunrise": "05:58",
+        "high": "高温 23.0℃",
+        "low": "低温 14.0℃",
+        "sunset": "18:09",
+        "aqi": 29.0,
+        "fx": "西北风",
+        "fl": "4-5级",
+        "type": "晴",
+        "notice": "愿你拥有比阳光明媚的心情"
+      },
+      {
+        "date": "24",
+        "ymd": "2018-09-22",
+        "week": "星期一",
+        "sunrise": "05:59",
+        "high": "高温 24.0℃",
+        "low": "低温 15.0℃",
+        "sunset": "18:07",
+        "aqi": 25.0,
+        "fx": "西北风",
+        "fl": "<3级",
+        "type": "晴",
+        "notice": "愿你拥有比阳光明媚的心情"
+      },
+      {
+        "date": "25",
+        "ymd": "2018-09-22",
+        "week": "星期二",
+        "sunrise": "06:00",
+        "high": "高温 24.0℃",
+        "low": "低温 16.0℃",
+        "sunset": "18:05",
+        "aqi": 56.0,
+        "fx": "西南风",
+        "fl": "<3级",
+        "type": "晴",
+        "notice": "愿你拥有比阳光明媚的心情"
+      },
+      {
+        "date": "26",
+        "ymd": "2018-09-22",
+        "week": "星期三",
+        "sunrise": "06:01",
+        "high": "高温 24.0℃",
+        "low": "低温 17.0℃",
+        "sunset": "18:04",
+        "aqi": 86.0,
+        "fx": "西南风",
+        "fl": "3-4级",
+        "type": "阴",
+        "notice": "不要被阴云遮挡住好心情"
+      }
+    ]
+  }
+}

app/src/main/java/com/bakerj/demo/rxretrohttp/APP.java

@@ -14,7 +14,7 @@ public class APP extends Application {
     public void onCreate() {
         super.onCreate();
         Utils.init(this);
-        RxRetroHttp.init(this)
+        RxRetroHttp.init(this).setMockEnable(true)//set mock enable
                 .setBaseUrl("https://api.github.com/")//your main url
                 .setDefaultErrMsg("Github开小差了")//default error hint message
                 .setApiResultClass(GithubApiResult.class)//your main api result structure, if not, will use default gson converter

app/src/main/java/com/bakerj/demo/rxretrohttp/MainActivity.java

@@ -2,11 +2,14 @@
 
 import android.content.Intent;
 import android.os.Bundle;
+import android.widget.Button;
+
 import androidx.appcompat.app.AppCompatActivity;
 
 import com.bakerj.demo.rxretrohttp.gank.GankActivity;
 import com.bakerj.demo.rxretrohttp.github.GithubActivity;
 import com.bakerj.demo.rxretrohttp.weather.WeatherActivity;
+import com.bakerj.rxretrohttp.RxRetroHttp;
 
 public class MainActivity extends AppCompatActivity {
 
@@ -20,5 +23,11 @@ protected void onCreate(Bundle savedInstanceState) {
                 .this, GankActivity.class)));
         findViewById(R.id.btn_weather).setOnClickListener(v -> startActivity(new Intent(MainActivity
                 .this, WeatherActivity.class)));
+        Button button = findViewById(R.id.btn_mock_enable);
+        button.setOnClickListener(v -> {
+            RxRetroHttp.getInstance().setMockEnable(!RxRetroHttp.isMockEnable());
+            button.setText("Click to " + (RxRetroHttp.isMockEnable() ? "disable" : "enable") +
+                    " mock");
+        });
     }
 }

app/src/main/java/com/bakerj/demo/rxretrohttp/entity/github/GithubUser.java

@@ -1,7 +1,5 @@
 package com.bakerj.demo.rxretrohttp.entity.github;
 
-import com.bakerj.demo.rxretrohttp.entity.github.GithubApiResult;
-
 public class GithubUser extends GithubApiResult {
     private String login;
     private String avatar_url;

app/src/main/java/com/bakerj/demo/rxretrohttp/entity/weather/Weather.java

@@ -8,7 +8,7 @@ public class Weather {
     private List<Forecast> forecast;
     private Yesterday yesterday;
     private String aqi;
-    private String city;
+    private CityInfo cityInfo;
 
     public String getWendu() {
         return wendu;
@@ -50,36 +50,48 @@ public void setAqi(String aqi) {
         this.aqi = aqi;
     }
 
-    public String getCity() {
-        return city;
+    public CityInfo getCityInfo() {
+        return cityInfo;
     }
 
-    public void setCity(String city) {
-        this.city = city;
+    public void setCityInfo(CityInfo cityInfo) {
+        this.cityInfo = cityInfo;
+    }
+
+    public class CityInfo{
+        private String city;
+
+        public String getCity() {
+            return city;
+        }
+
+        public void setCity(String city) {
+            this.city = city;
+        }
     }
 
     public class Forecast {
-        private String fengxiang;
-        private String fengli;
+        private String fx;
+        private String fl;
         private String high;
         private String type;
         private String low;
         private String date;
 
-        public String getFengxiang() {
-            return fengxiang;
+        public String getFx() {
+            return fx;
         }
 
-        public void setFengxiang(String fengxiang) {
-            this.fengxiang = fengxiang;
+        public void setFx(String fx) {
+            this.fx = fx;
         }
 
-        public String getFengli() {
-            return fengli;
+        public String getFl() {
+            return fl;
         }
 
-        public void setFengli(String fengli) {
-            this.fengli = fengli;
+        public void setFl(String fl) {
+            this.fl = fl;
         }
 
         public String getHigh() {
@@ -175,12 +187,12 @@ public void setDate(String date) {
     @Override
     public String toString() {
         StringBuilder stringBuilder = new StringBuilder();
-        stringBuilder.append(city).append("天气：\n")
+        stringBuilder.append(cityInfo.city).append("天气：\n")
                 .append("温度：").append(wendu).append("\n")
                 .append("注意：").append(ganmao).append("\n")
                 .append("五日天气预报：\n");
         for (Forecast f : forecast) {
-            stringBuilder.append(f.date + "：" + f.fengxiang + " " + f.type + " " + f.fengli + " "
+            stringBuilder.append(f.date + "：" + f.fx + " " + f.type + " " + f.fl + " "
                     + f.high + " " + f.low + "\n");
         }
         return stringBuilder.toString();