{"id":21622756,"url":"https://github.com/mushan0x0/wxapp-api-interceptors","last_synced_at":"2026-02-22T14:06:28.678Z","repository":{"id":46529085,"uuid":"133918237","full_name":"mushan0x0/wxapp-api-interceptors","owner":"mushan0x0","description":"微信小程序api拦截器","archived":false,"fork":false,"pushed_at":"2018-11-17T15:27:35.000Z","size":87,"stargazers_count":115,"open_issues_count":2,"forks_count":26,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-10T14:30:40.044Z","etag":null,"topics":["interceptor","javascript","promise","proxy","weapp","wxapp"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mushan0x0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-18T07:18:57.000Z","updated_at":"2025-03-20T14:50:17.000Z","dependencies_parsed_at":"2022-07-19T22:34:01.619Z","dependency_job_id":null,"html_url":"https://github.com/mushan0x0/wxapp-api-interceptors","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mushan0x0%2Fwxapp-api-interceptors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mushan0x0%2Fwxapp-api-interceptors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mushan0x0%2Fwxapp-api-interceptors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mushan0x0%2Fwxapp-api-interceptors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mushan0x0","download_url":"https://codeload.github.com/mushan0x0/wxapp-api-interceptors/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248381790,"owners_count":21094528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["interceptor","javascript","promise","proxy","weapp","wxapp"],"created_at":"2024-11-25T00:10:06.535Z","updated_at":"2026-02-22T14:06:23.658Z","avatar_url":"https://github.com/mushan0x0.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 微信小程序api拦截器\n\n- 完美兼容原生小程序项目\n- 完美兼用小程序api的原本调用方式，无痛迁移\n- 小程序api全Promise化\n- 和axios一样的请求方式\n- 小程序api自定义拦截调用参数和返回结果\n- 强大的async拦截\n\n## 快速开始\n\n### 安装\n\n```js\nnpm install wxapp-api-interceptors --save\n```\n\n### 使用\n\n##### mpvue等项目\n\n```js\nimport wxApiInterceptors from 'wxapp-api-interceptors';\n\nwxApiInterceptors(); // 必须在调用小程序api之前调用\n```\n\n##### 原生小程序和taro项目\n\n[下载](https://github.com/mushan0x0/wxapp-api-interceptors/archive/master.zip)该项目，解压移动文件夹`dist`里`wxApiInterceptors.js`和`runtime.js`文件到你自己的项目，详见[示例](https://github.com/mushan0x0/wxapp-api-interceptors/tree/master/example/wxapp)。\n\n```js\nconst wxApiInterceptors = require('./wxApiInterceptors');\n\nwxApiInterceptors(); // 必须在调用小程序api之前调用\n```\n\n## 小程序api调用\n\n不必传success、complete和fail参数。\n\n##### 函数式异步调用方式：\n\n```js\nwx.showLoading({title: '登录中...'})\n    .then(wx.login)\n    .then(data =\u003e wx.request.post('/login', {data}))\n    .then(() =\u003e wx.showToast({title: '登录成功'}))\n    .catch(() =\u003e wx.showToast({title: '登录失败'}))\n    .finally(wx.hideLoading);\n```\n\n##### 也兼容原生的调用方式（不便维护）：\n\n```js\nwx.showLoading({\n    title: '登录中...',\n    success: () =\u003e {\n        wx.login({\n            success: (data) =\u003e {\n                wx.request({\n                    url: '/login',\n                    data,\n                    success: () =\u003e wx.showToast({title: '登录成功'}),\n                    fail: () =\u003e wx.showToast({title: '登录失败'}),\n                    complete: wx.hideLoading,\n                });\n            },\n        });\n    },\n});\n```\n\n## 自定义拦截器\n\n使用方法及参数：`wxApiInterceptors({[api]: {[request](params):params, [response](res):res}}, [isReturn]: boolean)`\n\n#### 比如拦截wx.showModal的confirmColor默认值为red，调用成功后并拦截调用成功返回的结果。\n```js\nwxApiInterceptors({\n    showModal: {\n        request(params) {\n            if (params.confirmColor === undefined) {\n                params.confirmColor = 'red';\n            }\n            return params;\n        },\n        response(res) {\n            res = '调用成功';\n            return res;\n        },\n    }\n});\n\nwx.showModal({title: '测试'})\n    .then(console.log);\n// 控制的输出：调用成功\n```\n\n## 默认拦截了request api，封装成了和axios差不多的使用方式\n\n调用`wx.request[method](url, [config])`发送axios化的请求。\n\n##### 默认`GET`请求\n\n```js\nwx.request('https://test.com/banner')\n    .then(({data}) =\u003e {\n        console.log(data);\n    })\n```\n\n##### 其他请求方式\n\n```js\nwx.request.post('https://test.com', {data: {userName: 'test'}})\n    .then(({data}) =\u003e {\n        console.log(data);\n    })\n```\n\n## 当然也可以再继续拦截request api\n\n比如设置request api默认的host：\n\n```js\nwxApiInterceptors({\n    request: {\n        request(params) {\n            const host = 'https://test.com'\n            if (!/^(http|\\/\\/)/.test(params.url)) {\n                params.url = host + params.url;\n            }\n            return params;\n        },\n    },\n});\n```\n\n甚至可以拦截自己的业务状态码：\n\n```js\nwxApiInterceptors({\n    request: {\n        response(res) {\n            const {data: {code}} = res;\n            // 如果data里的code等于-1就响应为失败\n            if (code === -1) {\n                return Promise.reject(res);\n            }\n            return res;\n        },\n    },\n});\n```\n\n## 强大的async拦截器\n\n比如调用request api的时候都在header里带上本地储存的token，没有的话从服务器获取：\n\n```js\nwxApiInterceptors({\n    request: {\n        async request(params) {\n            if (params.header === undefined) {\n                params.header = {};\n            }\n            let token = wx.getStorageSync('token');\n            if (!token) {\n                ({data: token} = await wx.request('/getToken'));\n                wx.setStorageSync('token', token);\n            }\n            params.header.token = token;\n            return params;\n        },\n    },\n});\n```\n\n原生小程序项目使用async需要特殊处理，请看[示例](https://github.com/mushan0x0/wxapp-api-interceptors/tree/master/example/wxapp)。\n\n小程序基础版本2.0.8后的小程序，在后台配置了插件不能直接调用全局wx对象[issues](https://github.com/mushan0x0/wxapp-api-interceptors/issues/9)，需要在调用wxApiInterceptors({}, true)时传入第二个参数为true，会返回一个代理后的对象以供调用，请看[示例](https://github.com/mushan0x0/wxapp-api-interceptors/tree/master/example/wxapp)。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmushan0x0%2Fwxapp-api-interceptors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmushan0x0%2Fwxapp-api-interceptors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmushan0x0%2Fwxapp-api-interceptors/lists"}