瀏覽代碼

更新转换器使用文档

drake 3 年之前
父節點
當前提交
5851f39826
共有 1 個文件被更改,包括 13 次插入11 次删除
  1. 13 11
      docs/convert-data-field.md

+ 13 - 11
docs/convert-data-field.md

@@ -1,5 +1,5 @@
 
-## 转换完整的JSON
+## 具备状态码的JSON
 
 一般的解析过程是以下
 
@@ -7,10 +7,12 @@
 
 ```json
 {
-    "code":200,
-    "msg":"错误信息",
+    "code":0,
+    "msg":"请求成功",
     "data": {
-        "name": "彭于晏"
+        "name": "彭于晏",
+        "age": 27,
+        "height": 180
     }
 }
 ```
@@ -18,12 +20,12 @@
 2. 创建数据模型
 
 ```kotlin
-data class UserInfo (
+data class UserModel (
     var code:Int,
     var msg:String,
-    var data:Info,
+    var data:Data,
 ) {
-
+    data class Data(var name: String, var age: Int, var height: Int)
 }
 ```
 
@@ -31,18 +33,18 @@ data class UserInfo (
 
 ```kotlin
 scopeNetLife {
-    val data = Get<UserInfo>("/list").await().data
+    val data = Get<UserModel>("api").await().data
 }
 ```
 
-## 仅转换Data字段
+## 摘取Data字段
 
 这样每次都要`await().data`才是你要的`data`对象. 有些人就想省略直接不写code和msg, 希望直接返回data. 那么在转换器里面就只解析data字段即可
 
 简化数据对象
 
 ```kotlin
-data class Info (var name:String)
+data class UserModel(var name: String, var age: Int, var height: Int)
 ```
 
 转换器只解析data字段
@@ -62,7 +64,7 @@ class GsonConvert : JSONConvert(code = "code", message = "msg", success = "200")
 
 ```kotlin
 scopeNetLife {
-    val data = Get<Info>("/list").await().data
+    val data = Get<Info>("api").await().data
 }
 ```