@lark-apaas/client-toolkit 1.2.73 → 1.2.74-alpha.20261011014021

package/README.md

@@ -1,5 +1,21 @@
 # @lark-apaas/client-toolkit
 
+## 后端 API 请求
+
+`axiosForBackend` 是可调用且带有 `.get`、`.post` 等方法的 Axios 实例。它会将
+HTTP 403 响应作为 fulfilled response 返回，而不是交给 `catch`。保留完整 response，
+先终止 403 分支，再读取 `response.data` 或执行成功副作用：
+
+```typescript
+import { axiosForBackend } from '@lark-apaas/client-toolkit/utils/getAxiosForBackend';
+
+const response = await axiosForBackend.get('/api/resources');
+if (response.status === 403) {
+  throw new Error('无权限执行此操作');
+}
+const resources = response.data;
+```
+
 ## 项目架构设计
 
 ### apis 目录

package/lib/utils/getAxiosForBackend.d.ts

@@ -6,6 +6,16 @@ declare module 'axios' {
         };
     }
 }
-/** 获取axios实例 */
+/**
+ * 获取供前端调用后端接口的 Axios 实例。
+ *
+ * 该实例会将 HTTP 403 响应作为 fulfilled response 返回。调用方必须先保留完整
+ * response，在读取 response.data 或执行成功副作用前处理 response.status === 403，
+ * 并终止该分支。
+ */
 export declare function getAxiosForBackend(): AxiosInstance;
+/**
+ * 供前端调用后端接口的 Axios 实例。HTTP 403 会作为 fulfilled response 返回；先检查
+ * response.status 并终止 403 分支，再读取 response.data 或执行成功副作用。
+ */
 export declare const axiosForBackend: AxiosInstance;

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@lark-apaas/client-toolkit",
-  "version": "1.2.73",
+  "version": "1.2.74-alpha.20261011014021",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
   "files": [
     "lib"
   ],
+  "httpContracts": {
+    "axiosForBackend": {
+      "forbiddenResponse": "fulfilled"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },