Browse Source

编辑文档-请求参数

drake 3 năm trước cách đây
mục cha
commit
a0d5678bf4
2 tập tin đã thay đổi với 75 bổ sung74 xóa
  1. 0 74
      docs/index.md
  2. 75 0
      docs/request-params.md

+ 0 - 74
docs/index.md

@@ -69,80 +69,6 @@ scopeNetLife {
 
 
 <br>
-关于JSON解析以及全局URL等初始化配置后面讲解
-
-## 请求参数
-关于请求参数参数
-```kotlin
-scopeNetLife { // 创建作用域
-    // 这个大括号内就属于作用域内部
-    val data = Get<String>("http://www.baidu.com/"){
-        param("u_name", "drake")
-        param("pwd", "123456")
-    }.await() // 发起GET请求并返回`String`类型数据
-}
-```
-
-|请求函数|描述|
-|-|-|
-|`param`|支持基础类型/文件/RequestBody/Part|
-|`json`|请求参数为JSONObject/JsonArray/String|
-|`setQuery`|Url参数, 如果当前请求的Url请求则该函数等效于`param`函数|
-
-
-
-### JSON请求体
-
-这里提供三种创建Json请求的示例代码. 酌情选用
-
-=== "JSON键值对(推荐)"
-    ```kotlin
-    val name = "金城武"
-    val age = 29
-    val measurements = listOf(100, 100, 100)
-
-    scopeNetLife {
-        tv_fragment.text = Post<String>("api") {
-            json("name" to name, "age" to age, "measurements" to measurements) // 同时也支持Map集合
-        }.await()
-    }
-    ```
-
-=== "JSONObject"
-    ```kotlin
-    val name = "金城武"
-    val age = 29
-    val measurements = listOf(100, 100, 100)
-
-    scopeNetLife {
-        tv_fragment.text = Post<String>("api") {
-            json(JSONObject().run {
-                put("name", name)
-                put("age", age)
-                put("measurements", JSONArray(measurements))
-            })
-        }.await()
-    }
-    ```
-
-=== "自定义的body"
-    ```kotlin
-    val name = "金城武"
-    val age = 29
-    val measurements = listOf(100, 100, 100)
-
-    scopeNetLife {
-        tv_fragment.text = Post<String>("api") {
-            body(MyJsonBody(name, age, measurements))
-        }.await()
-    }
-    ```
-
-对于某些可能JSON请求参数存在固定值:
-
-1. 可以考虑继承RequestBody来扩展出自己的新的Body(), 然后使用`param`函数传入请求中.
-2. 定义拦截器
-
 
 ## RESTFUL
 Net支持RestFul设计风格

+ 75 - 0
docs/request-params.md

@@ -30,6 +30,81 @@ scopeNetLife {
 }
 ```
 
+## 表单请求
+关于请求参数参数
+```kotlin
+scopeNetLife { // 创建作用域
+    // 这个大括号内就属于作用域内部
+    val data = Get<String>("http://www.baidu.com/"){
+        param("u_name", "drake")
+        param("pwd", "123456")
+    }.await() // 发起GET请求并返回`String`类型数据
+}
+```
+
+|请求函数|描述|
+|-|-|
+|`param`|支持基础类型/文件/RequestBody/Part|
+|`json`|请求参数为JSONObject/JsonArray/String|
+|`setQuery`|Url参数, 如果当前请求的Url请求则该函数等效于`param`函数|
+
+
+
+## JSON请求
+
+这里提供三种创建Json请求的示例代码. 酌情选用
+
+=== "JSON键值对(推荐)"
+    ```kotlin
+    val name = "金城武"
+    val age = 29
+    val measurements = listOf(100, 100, 100)
+
+    scopeNetLife {
+        tv_fragment.text = Post<String>("api") {
+            json("name" to name, "age" to age, "measurements" to measurements) // 同时也支持Map集合
+        }.await()
+    }
+    ```
+
+=== "JSONObject"
+    ```kotlin
+    val name = "金城武"
+    val age = 29
+    val measurements = listOf(100, 100, 100)
+
+    scopeNetLife {
+        tv_fragment.text = Post<String>("api") {
+            json(JSONObject().run {
+                put("name", name)
+                put("age", age)
+                put("measurements", JSONArray(measurements))
+            })
+        }.await()
+    }
+    ```
+
+=== "自定义的body"
+    ```kotlin
+    val name = "金城武"
+    val age = 29
+    val measurements = listOf(100, 100, 100)
+
+    scopeNetLife {
+        tv_fragment.text = Post<String>("api") {
+            body(MyJsonBody(name, age, measurements))
+        }.await()
+    }
+    ```
+
+对于某些可能JSON请求参数存在固定值:
+
+1. 可以考虑继承RequestBody来扩展出自己的新的Body(), 然后使用`param`函数传入请求中.
+2. 添加请求拦截器[RequestInterceptor](/interceptor/#_1)
+
+
+## 请求函数
+
 关于具体函数希望阅读源码. Net源码全部有文档注释, 以及函数结构分组
 
 <img src="https://i.imgur.com/oZp9WYZ.png" width="420"/>