docs: 更新文档

docs/auto-dialog.md

@@ -5,8 +5,8 @@ Net支持发起请求开始时显示加载框, 请求结束时隐藏加载框(
 
 ```kotlin hl_lines="1"
 scopeDialog {
-    tvFragment.text = Post<String>("dialog") {
-        param("u_name", "drake") // 请求参数
+    tvFragment.text = Post<String>(Api.PATH) {
+        param("username", "用户名") // 请求参数
         param("pwd", "123456")
     }.await()
 }
@@ -27,8 +27,8 @@ scopeDialog {
 val dialog = BubbleDialog(requireActivity(), "加载中")
 
 scopeDialog(dialog) {
-    binding.tvFragment.text = Post<String>("dialog") {
-        param("u_name", "drake")
+    binding.tvFragment.text = Post<String>(Api.PATH) {
+        param("username", "用户名")
         param("pwd", "123456")
     }.await()
 }

docs/auto-pull.md

@@ -8,7 +8,7 @@
 ```kotlin
 page.onRefresh {
     scope {
-        val data = Get<ListModel>("list") {
+        val data = Get<Game>(Api.PATH) {
             param("page", index)
         }.await().data
         addData(data.list) {

docs/auto-refresh.md

@@ -47,7 +47,7 @@ rv_push.linear().setup {
 page.onRefresh {
     scope {
         // 请求到数据设置到RecyclerView
-        rv_push.models = Get<ListModel>("list").await().data.list
+        rv_push.models = Get<Game>(Api.PATH).await().data.list
     }
 }.autoRefresh()
 ```

docs/auto-state.md

@@ -56,7 +56,7 @@ StateConfig.apply {
 ```kotlin
 state.onRefresh {
     scope {
-        tvFragment.text = Get<String>("api").await()
+        tvFragment.text = Get<String>(Api.PATH).await()
     }
 }.showLoading()
 ```

docs/cache.md

@@ -38,7 +38,7 @@ OkHttp默认的Http缓存协议控制, 要求以下条件
 
 ```kotlin
 scopeNetLife {
-    Post<String>("api") {
+    Post<String>(Api.PATH) {
         setCacheControl(CacheControl.FORCE_CACHE) // 强制使用缓存
         // setCacheControl(CacheControl.FORCE_NETWORK) // 强制使用网络
         // setCacheControl(CacheControl.Builder().noStore().noCache().build()) // 完全禁止读取/写入缓存
@@ -55,7 +55,7 @@ scopeNetLife {
 ```kotlin
 scopeNetLife {
     binding.tvFragment.text =
-        Post<String>("api") {
+        Post<String>(Api.PATH) {
             setCacheMode(CacheMode.REQUEST_THEN_READ) // 请求网络失败会读取缓存, 请断网测试
         }.await()
 }
@@ -77,7 +77,7 @@ scopeNetLife {
 ```kotlin
 scopeNetLife {
     binding.tvFragment.text =
-        Post<String>("api") {
+        Post<String>(Api.PATH) {
             setCacheMode(CacheMode.REQUEST_THEN_READ) // 请求网络失败会读取缓存, 请断网测试
             setCacheKey("请求热门信息" + params) // 具体值都行
         }.await()
@@ -92,7 +92,7 @@ scopeNetLife {
 ```kotlin
 scopeNetLife {
     binding.tvFragment.text =
-        Post<String>("api") {
+        Post<String>(Api.PATH) {
             setCacheMode(CacheMode.REQUEST_THEN_READ) // 请求网络失败会读取缓存, 请断网测试
             setCacheValidTime(1, TimeUnit.DAYS) // 缓存仅一天内有效
         }.await()
@@ -106,13 +106,13 @@ scopeNetLife {
 ```kotlin
 scopeNetLife {
     // 然后执行这里(网络请求)
-    binding.tvFragment.text = Get<String>("api") {
+    binding.tvFragment.text = Get<String>(Api.PATH) {
         setCacheMode(CacheMode.WRITE)
     }.await()
     Log.d("日志", "网络请求")
 }.preview(true) {
     // 先执行这里(仅读缓存), 任何异常都视为读取缓存失败
-    binding.tvFragment.text = Get<String>("api") {
+    binding.tvFragment.text = Get<String>(Api.PATH) {
         setCacheMode(CacheMode.READ)
     }.await()
     Log.d("日志", "读取缓存")

docs/cancel.md

@@ -3,7 +3,7 @@
 ```kotlin
 downloadScope = scopeNetLife {
     // 下载文件
-    val file = Get<File>("download").await()
+    val file = Get<File>(Api.DOWNLOAD).await()
 }
 
 downloadScope.cancel() // 取消下载
@@ -14,7 +14,7 @@ downloadScope.cancel() // 取消下载
 
 ```kotlin
 scopeNetLife {
-    tvFragment.text = Get<String>("api"){
+    tvFragment.text = Get<String>(Api.DOWNLOAD){
         setId("请求用户信息")
     }.await()
 }

docs/config.md

@@ -72,7 +72,7 @@ NetConfig.initialize(Api.HOST, this) {
     指定Path(例如`/api/index`)会自动和`NetConfig.host`拼接组成Url, 但指定以`http/https`开头的全路径则直接作为请求Url
     ```kotlin
     scopeNetLife {
-        val data = Get<String>("https://github.com/path").await()
+        val data = Get<String>("https://github.com/liangjingkanji/net").await()
     }
     ```
 
@@ -81,7 +81,7 @@ NetConfig.initialize(Api.HOST, this) {
 
     ```kotlin
     scopeNetLife {
-        val data = Get<String>("/api/index", "User").await() // User即为tag
+        val data = Get<String>(Api.PATH, "User").await() // User即为tag
     }
     // 拦截器修改请求URL不做介绍
     ```

docs/converter-customize.md

@@ -7,7 +7,7 @@ Net自定义转换器可支持任何数据类型, 甚至`Bitmap`
 
 ```kotlin
 scopeNetLife {
-    val userList = Get<List<UserModel>>("list") {
+    val userList = Get<List<UserModel>>(Api.PATH) {
         converter = GsonConverter()
     }.await()
 }
@@ -26,7 +26,7 @@ Net由于低耦合原则不自带任何序列化框架
 === "单例"
     ```kotlin hl_lines="3"
     scopeNetLife {
-       tvFragment.text = Get<String>("api"){
+       tvFragment.text = Get<String>(Api.PATH){
             converter = SerializationConverter()
        }.await()
     }

docs/converter-struct.md

@@ -32,7 +32,7 @@
 === "网络请求"
     ```kotlin
     scopeNetLife {
-        val data = Get<UserModel>("api").await().data
+        val data = Get<UserModel>(Api.USER).await().data
     }
     ```
 
@@ -81,7 +81,7 @@ class GsonConvert : JSONConvert(code = "code", message = "msg", success = "200")
 
 ```kotlin
 scopeNetLife {
-    val data = Get<UserModel>("api").await()
+    val data = Get<UserModel>(Api.USER).await()
 }
 ```
 

docs/converter.md

@@ -1,6 +1,6 @@
 Net支持请求返回的数据类型取决于你的转换器实现
 
-# Get<任何对象>("path").await()
+# Get<任何对象>(Api.PATH).await()
 
 默认转换器支持返回以下数据类型
 
@@ -16,7 +16,7 @@ Net支持请求返回的数据类型取决于你的转换器实现
 
 ```kotlin
 scopeNetLife {
-    Get<Response>("api").await().headers("响应头名称") // 返回响应头
+    Get<Response>(Api.PATH).await().headers("响应头名称") // 返回响应头
 }
 ```
 

docs/coroutine-request.md

@@ -7,7 +7,7 @@ val job = scopeNetLife {
     repeat(10000) {
         // 这里将返回的数据显示在TextView上
         launch {
-            tvFragment.text = Get<String>("https://github.com/liangjingkanji/Net/").await()
+            tvFragment.text = Get<String>(Api.PATH).await()
         }
     }
 }

docs/debounce.md

@@ -31,4 +31,6 @@ binding.etInput.debounce().distinctUntilChanged().launchIn(this) {
 指定参数设置节流阀超时时间
 ```kotlin
 fun EditText.debounce(timeoutMillis: Long = 800)
-```
+```
+<br>
+1. [示例-自动搜索分页列表](https://github.com/liangjingkanji/Net/blob/a78d46118666a3509d3fcc79c1d28ad81e2d5a57/sample/src/main/java/com/drake/net/sample/ui/fragment/EditDebounceFragment.kt)

docs/download-file.md

@@ -2,7 +2,7 @@
 
 ```kotlin
 scopeNetLife {
-    val file = Get<File>("download").await()
+    val file = Get<File>(Api.DOWNLOAD).await()
 }
 ```
 
@@ -13,7 +13,7 @@ scopeNetLife {
 ```kotlin
 scopeNetLife {
     val file =
-        Get<File>("https://download.sublimetext.com/Sublime%20Text%20Build%203211.dmg") {
+        Get<File>("https://github.com/liangjingkanji/Net/releases/latest/download/net-sample.apk") {
             setDownloadFileName("net.apk")
             setDownloadDir(requireContext().filesDir)
             setDownloadMd5Verify()

docs/error-single.md

@@ -7,28 +7,28 @@
 例如
 ```kotlin
 scopeNetLife {
-    Get<String>("api").await() // 失败
-    Get<String>("api2").await() // 上面失败, 此处也不会执行
+    Get<String>("path").await() // 失败
+    Get<String>("path2").await() // 上面失败, 此处也不会执行
 }
 ```
 
 捕获第一个协程避免终止后续执行
 ```kotlin
 scopeNetLife {
     try {
-        Get<String>("api").await() // 失败
+        Get<String>("path").await() // 失败
     } catch(e:Exception) {
     }
-    Get<String>("api2").await() // 上面失败, 此处继续执行
+    Get<String>("path2").await() // 上面失败, 此处继续执行
 }
 ```
 当然如果创建不同的作用域分别请求那是互不影响的
 ```kotlin
 scopeNetLife {
-    Get<String>("api").await() // 失败
+    Get<String>("path").await() // 失败
 }
 scopeNetLife {
-    Get<String>("api2").await() // 上面失败, 此处完全不受影响
+    Get<String>("path2").await() // 上面失败, 此处完全不受影响
 }
 ```
 
@@ -38,7 +38,7 @@ scopeNetLife {
 
 ```kotlin
 scope {
-    val data = Get<String>("http://www.thisiserror.com/").await()
+    val data = Get<String>("http://www.error.com/").await()
 }.catch {
     // 协程内发生错误回调, it为异常对象
 }.finally {

docs/fastest.md

@@ -11,10 +11,10 @@
 scopeNetLife {
 
     // 同时发起四个网络请求
-    val deferred = Get<String>("api0") // 错误接口
-    val deferred1 = Get<String>("api1") // 错误接口
-    val deferred2 = Get<String>("api")
-    val deferred3 = Post<String>("api")
+    val deferred = Get<String>("path") // 错误接口
+    val deferred1 = Get<String>("path1") // 错误接口
+    val deferred2 = Get<String>("path2")
+    val deferred3 = Post<String>("path3")
 
     // 只返回最快的请求结果
     tvFragment.text = fastest(deferred, deferred1, deferred2, deferred3)
@@ -29,10 +29,10 @@ scopeNetLife {
 ```kotlin
 scopeNetLife {
     // 同时发起四个网络请求
-    val deferred2 = Get<String>("api") { setGroup("初始化") }
-    val deferred3 = Post<String>("api") { setGroup("初始化") }
-    val deferred = Get<String>("api0") { setGroup("初始化") } // 错误接口
-    val deferred1 = Get<String>("api1") { setGroup("初始化") } // 错误接口
+    val deferred2 = Get<String>("path") { setGroup("初始化") }
+    val deferred3 = Post<String>("path1") { setGroup("初始化") }
+    val deferred = Get<String>("path2") { setGroup("初始化") } // 错误接口
+    val deferred1 = Get<String>("path3") { setGroup("初始化") } // 错误接口
 
     // 只返回最快的请求结果
     tvFragment.text = fastest(listOf(deferred, deferred1, deferred2, deferred3), "初始化")
@@ -46,12 +46,12 @@ scopeNetLife {
 ```kotlin
 scopeNetLife {
 
-    val fastest = Post<String>("api").transform {
+    val fastest = Post<String>("path").transform {
         Log.d("日志", "Post") // 如果该接口最快则会回调这里
         it // 这里可以返回其他数据结果
     }
 
-    val fastest2 = Get<String>("api").transform {
+    val fastest2 = Get<String>("path").transform {
         Log.d("日志", "Get") // 如果该接口最快则会回调这里
         it
     }
@@ -65,17 +65,17 @@ scopeNetLife {
 ## 捕获错误
 ```kotlin
 scopeNetLife {
-    val task = Get<String>("api2")
-    val task1 = Get<String>("api2")
-    val task2 = Get<String>("api2")
+    val task = Get<String>("path")
+    val task1 = Get<String>("path1")
+    val task2 = Get<String>("path2")
 
     val data = try {
         fastest(listOf(task, task1, task2))
     // 当task/task1/task2全部错误后才并发执行backupTask/backupTask1
     } catch (e: Exception) {
-        val backupTask = Get<String>("api2")
-        val backupTask1 = Get<String>("api")
-        fastest(listOf(backupTask, backupTask1))
+        val task3 = Get<String>("path3")
+        val task4 = Get<String>("path4")
+        fastest(listOf(task3, task4))
     }
 }
 ```

docs/https.md

@@ -6,7 +6,7 @@ Https如果使用的CA证书, 不需要任何配置可以直接访问
 
 ```kotlin
 scopeNetLife {
-    tvFragment.text = Get<String>("https://github.com/liangjingkanji/Net/").await()
+    tvFragment.text = Get<String>(Api.PATH).await()
 }
 ```
 
@@ -25,7 +25,7 @@ scopeNetLife {
 
     ```kotlin
     scopeNetLife {
-        Get<String>("https://github.com/liangjingkanji/Net/"){
+        Get<String>(Api.PATH){
           setClient {
               trustSSLCertificate()
           }
@@ -50,7 +50,7 @@ scopeNetLife {
 
     ```kotlin
     scopeNetLife {
-        Get<String>("https://github.com/liangjingkanji/Net/") {
+        Get<String>(Api.PATH) {
             setClient {
                 val privateCertificate = resources.assets.open("https.certificate") // 这里的证书是放到应用的资产目录下
                 setSSLCertificate(privateCertificate)