{"id":13672777,"url":"https://github.com/ckpack/mock-axios","last_synced_at":"2025-06-22T04:10:06.228Z","repository":{"id":57681756,"uuid":"470552667","full_name":"ckpack/mock-axios","owner":"ckpack","description":"Mock axios requests for testing and development","archived":false,"fork":false,"pushed_at":"2022-03-30T06:41:37.000Z","size":356,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-12T18:07:55.089Z","etag":null,"topics":["axios","mock","mock-axios","moxios"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ckpack.png","metadata":{"files":{"readme":"README-ZH.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-16T11:24:08.000Z","updated_at":"2022-03-19T07:47:19.000Z","dependencies_parsed_at":"2022-09-03T19:51:56.674Z","dependency_job_id":null,"html_url":"https://github.com/ckpack/mock-axios","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckpack%2Fmock-axios","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckpack%2Fmock-axios/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckpack%2Fmock-axios/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckpack%2Fmock-axios/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ckpack","download_url":"https://codeload.github.com/ckpack/mock-axios/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241230112,"owners_count":19930922,"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":["axios","mock","mock-axios","moxios"],"created_at":"2024-08-02T09:01:47.614Z","updated_at":"2025-02-28T20:44:33.871Z","avatar_url":"https://github.com/ckpack.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# mock-axios\n\n\u003ch4 align=\"center\"\u003e\n  \u003ca href=\"/README-ZH.md\"\u003e中文\u003c/a\u003e\n  |\n  \u003ca href=\"/README.md\"\u003eENGLISH\u003c/a\u003e\n\u003c/h4\u003e\n\n拦截`Axios`请求返还`Mock`数据, 用于测试和开发。\n\n## 接口\n\n### mockAxios\n\n`(mockDatas: MockConfig[], mockOptions?: MockOptions | undefined) =\u003e void`: Mock `Axios`\n\n+ `mockDatas`: 一个数组, 当`axios`请求时，会检查对应的`url`、 `method`，当匹配时会返回对应的`response`数据。\n  + `url`: `string | RegExp`类型, 需要匹配的url, 可以是字符串或正则表达式。当是字符串时会检查`axios`请求的`url`是否包含有该`url`。当是正则表达式时会检查`axios`请求的`url`是否匹配该`url`。\n  + `method`: `GET` | `POST` | `PUT` | `DELETE` | `PATCH`, 默认为空即匹配所有类型的请求\n  + `timeout`: `number`类型, 默认值: `300`, 单位: `ms`, 返回结果的延迟的时间\n  + `response`: 返回的mock的数据对象\n  + `adapter`: 自定义的适配器函数,参考[adapter](https://github.com/axios/axios/tree/master/lib/adapters), 该函数接受两个参数一个是`config`，一个是匹配到的`mockData`对象，返回值为`response`的数据对象，通过该参数你可以更自由的定义返回的数据（如验证接口权限）。\n+ `mockOptions`\n  + `isUseDefaultAdapter`: `Boolean`, 默认为 `true`, 如果开启，没有拦截到的请求会以`axios`默认方式发送请求\n  + `isEffect`: `Boolean`, 默认为 `true`, 通过该参数你可以在测试环境中打开`mockAxios`，在生产环境中关闭`mockAxios`\n  + `isLog`: `Boolean`, 默认为 `true`, 是否打印`mockAxios`的请求日志\n  + `logger`: `Function`, 替换默认的日志函数\n\n```js\nimport { mockAxios } from '@ckpack/mock-axios';\n\nmockAxios([{\n  url: 'https://test.com/v1/user/1',\n  response: { \n    data: { \n      id: 1,\n      name: 'admin',\n    }, \n  },\n}], {\n  isEffect: process.env.NODE_ENV === 'development',\n});\n```\n\n### defineConfig\n\n`(mockDatas: MockConfig[]) =\u003e MockConfig[]`: 构造mockDatas的辅助函数。该函数可以配合IDE来获取类型提示\n\n+ `mockDatas`: 同`mockAxios`的`mockDatas`参数。\n\n```js\nimport { defineConfig } from '@ckpack/mock-axios';\n\nconst mockDatas = defineConfig([\n  {\n    url: 'https://test.com/v1/user/1',\n    response: {\n      data: {\n        id: 1,\n        name: 'admin',\n      },\n    },\n  },\n]);\n```\n\n## 例子\n\n```ts\n// mockAxios.js\nimport { mockAxios } from '@ckpack/mock-axios';\n\nmockAxios([{\n  method: 'GET',\n  url: /https:\\/\\/test.com\\/v1\\/user\\/\\d+/,\n  response: { \n    data: [{ \n      id: 1,\n      name: 'admin',\n    }], \n  },\n}, {\n  method: 'POST',\n  url: 'https://test.com/v1/user/create',\n  adapter: (axiosConfig) =\u003e {\n    return {\n      data: axiosConfig.data,\n    };\n  },\n}]);\n```\n\n在其他文件中\n\n```ts\nimport axios from 'axios';\nimport './mockAxios.js';\n\nawait axios.get('https://test.com/v1/user/1');\n// 返回 { data: [{ id: 1, name: 'admin' }] }\n\nawait axios.post('https://test.com/v1/user/create', {\n  id: 1,\n  name: 'admin',\n});\n// 返回 { data: { id: 1, name: 'admin' } }\nawait axios.post('https://test.com/v1/user/create', {\n  id: 2,\n  name: 'test',\n});\n// 返回 { data: { id: 2, name: 'test' } }\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fckpack%2Fmock-axios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fckpack%2Fmock-axios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fckpack%2Fmock-axios/lists"}