\n
![\"Scap:](\"https://wangchujiang.com/appicon/scap.png\")
\n ![\"Screen](\"https://wangchujiang.com/appicon/screen-test.png\")
\n ![\"Deskmark\"](\"https://wangchujiang.com/appicon/deskmark.png\")
\n ![\"Keyzer\"](\"https://wangchujiang.com/appicon/keyzer.png\")
\n ![\"Vidwall](\"https://wangchujiang.com/appicon/vidwall-hub.png\")
\n ![\"VidCrop\"](\"https://wangchujiang.com/appicon/vidcrop.png\")
\n ![\"Vidwall\"](\"https://wangchujiang.com/appicon/vidwall.png\")
\n ![\"Mousio](\"https://wangchujiang.com/appicon/mousio-hint.png\")
\n ![\"Mousio\"](\"https://wangchujiang.com/appicon/mousio.png\")
\n ![\"Musicer\"](\"https://wangchujiang.com/appicon/musicer.png\")
\n ![\"Audioer\"](\"https://wangchujiang.com/appicon/audioer.png\")
\n ![\"FileSentinel\"](\"https://wangchujiang.com/appicon/file-sentinel.png\")
\n ![\"FocusCursor\"](\"https://wangchujiang.com/appicon/focus-cursor.png\")
\n ![\"Videoer\"](\"https://wangchujiang.com/appicon/videoer.png\")
\n ![\"KeyClicker\"](\"https://wangchujiang.com/appicon/key-clicker.png\")
\n ![\"DayBar\"](\"https://wangchujiang.com/appicon/daybar.png\")
\n ![\"Iconed\"](\"https://wangchujiang.com/appicon/iconed.png\")
\n ![\"Mousio\"](\"https://wangchujiang.com/appicon/rightmenu-master.png\")
\n ![\"Quick](\"https://wangchujiang.com/appicon/paste-quick.png\")
\n ![\"Quick](\"https://wangchujiang.com/appicon/quick-rss.png\")
\n ![\"Web](\"https://wangchujiang.com/appicon/web-serve.png\")
\n ![\"Copybook](\"https://wangchujiang.com/appicon/copybook-generator.png\")
\n ![\"DevTutor](\"https://wangchujiang.com/appicon/devtutor.png\")
\n ![\"RegexMate\"](\"https://wangchujiang.com/appicon/regex-mate.png\")
\n ![\"Time](\"https://wangchujiang.com/appicon/time-passage.png\")
\n ![\"Iconize](\"https://wangchujiang.com/appicon/iconize-folder.png\")
\n ![\"Textsound](\"https://wangchujiang.com/appicon/textsound-saver.png\")
\n ![\"Create](\"https://wangchujiang.com/appicon/create-custom-symbols.png\")
\n ![\"DevHub\"](\"https://wangchujiang.com/appicon/devhub.png\")
\n ![\"Resume](\"https://wangchujiang.com/appicon/resume-revise.png\")
\n ![\"Palette](\"https://wangchujiang.com/appicon/palette-genius.png\")
\n ![\"Symbol](\"https://wangchujiang.com/appicon/symbol-scribe.png\")
\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n
\n \n ![\"Buy](\"https://img.shields.io/badge/Buy_Me_a_Coffee-ffdd00?logo=buy-me-a-coffee&logoColor=black\"){kind=icon}
![\"Follow](\"https://img.shields.io/badge/Follow%20on%20X-333333?logo=x&logoColor=white\"){kind=icon}
![\"Build](\"https://github.com/jaywcjlove/mocker-api/actions/workflows/ci.yml/badge.svg\"){kind=icon}
\n \n \n ![\"Download\"](\"https://img.shields.io/npm/dm/mocker-api.svg?style=flat\")
\n \n
\n \n \n \n \n
![\"Open](\"https://img.shields.io/badge/Open%20in-unpkg-blue\"){kind=icon}
![\"npm](\"https://img.shields.io/npm/v/mocker-api.svg\")
\n \n
\n 中文 · \n Quick Start · \n Usage · \n Options · \n Delayed · \n Example · \n License · \n type\n
\n\n`mocker-api` creates mocks for REST APIs. It is helpful when you need to test your application without the actual REST API server.\n\n**Features:** \n\n🔥 Built-in support for hot Mocker file replacement. \n🚀 Quickly and easily configure the API via JSON. \n🌱 Mock API proxying made simple. \n💥 Can be used independently without relying on [webpack](https://github.com/webpack/webpack) and [webpack-dev-server](https://github.com/webpack/webpack-dev-server).\n\n## Quick Start\n\n```bash\nmkdir mocker-app && cd mocker-app\n\n# Create a mocker configuration file based on rules\ntouch api.js\n\n# Global install dependent.\nnpm install mocker-api -g\n\n# Default port: 3721\nmocker ./api.js\n\n# Designated port\n# Run server at localhost:8000\nmocker ./api.js --host localhost --port 8000\n```\n\n## Installation\n\nyou can put it the `package.json` config as a current project dependency.\n\n```bash\nnpm install mocker-api --save-dev\n```\n\n## Usage\n\n`mocker-api` dev support mock, configured in `mocker/index.js`.\n\nyou can modify the [http-proxy](https://www.npmjs.com/package/http-proxy) options and add the event listeners by adding the httpProxy configuration\n\n```js\nconst proxy = {\n // Priority processing.\n // apiMocker(app, path, option)\n // This is the option parameter setting for apiMocker\n _proxy: {\n proxy: {\n // Turn a path string such as `/user/:name` into a regular expression.\n // https://www.npmjs.com/package/path-to-regexp\n '/repos/*path': 'https://api.github.com/',\n '/:owner/:repo/raw/:ref/*path': 'http://127.0.0.1:2018',\n '/api/repos/*path': 'http://127.0.0.1:3721/'\n },\n // rewrite target's url path. Object-keys will be used as RegExp to match paths.\n // https://github.com/jaywcjlove/mocker-api/issues/62\n pathRewrite: {\n '^/api/repos/': '/repos/',\n },\n changeHost: true,\n // modify the http-proxy options\n httpProxy: {\n options: {\n ignorePath: true,\n },\n listeners: {\n proxyReq: function (proxyReq, req, res, options) {\n console.log('proxyReq');\n },\n },\n }, \n },\n // =====================\n // The default GET request.\n // https://github.com/jaywcjlove/mocker-api/pull/63\n '/api/user': {\n id: 1,\n username: 'kenny',\n sex: 6\n },\n 'GET /api/user': {\n id: 1,\n username: 'kenny',\n sex: 6\n },\n 'GET /api/user/list': [\n {\n id: 1,\n username: 'kenny',\n sex: 6\n }, {\n id: 2,\n username: 'kenny',\n sex: 6\n }\n ],\n 'GET /api/:owner/:repo/raw/:ref/*path': (req, res) => {\n const { owner, repo, ref } = req.params;\n // http://localhost:8081/api/admin/webpack-mock-api/raw/master/add/ddd.md\n // owner => admin\n // repo => webpack-mock-api\n // ref => master\n // req.params.path => add/ddd.md\n return res.json({\n id: 1,\n owner, repo, ref,\n path: req.params.path\n });\n },\n 'POST /api/login/account': (req, res) => {\n const { password, username } = req.body;\n if (password === '888888' && username === 'admin') {\n return res.json({\n status: 'ok',\n code: 0,\n token: \"sdfsdfsdfdsf\",\n data: {\n id: 1,\n username: 'kenny',\n sex: 6\n }\n });\n } else {\n return res.status(403).json({\n status: 'error',\n code: 403\n });\n }\n },\n 'DELETE /api/user/:id': (req, res) => {\n console.log('---->', req.body)\n console.log('---->', req.params.id)\n res.send({ status: 'ok', message: '删除成功！' });\n }\n}\nmodule.exports = proxy;\n```\n\n## Options \n\n- [`proxy`](https://www.npmjs.com/package/path-to-regexp) => `{}` Proxy settings, Turn a path string such as `/user/:name` into a regular expression.\n- [`pathRewrite`](https://github.com/jaywcjlove/mocker-api/issues/62) => `{}` rewrite target's url path. Object-keys will be used as RegExp to match paths. [#62](https://github.com/jaywcjlove/mocker-api/issues/62)\n- `withFullUrlPath=false` => `Boolean` the proxy regular expression support full url path. if the proxy regular expression like `/test?a=1&b=1` can be matched. [#25](https://github.com/jaywcjlove/mocker-api/issues/25)\n- `priority` => `proxy` priority `proxy` or `mocker` [#151](https://github.com/jaywcjlove/mocker-api/issues/151)\n- `changeHost` => `Boolean` Setting req headers host.\n- `httpProxy` => `{}` Set the [listen event](https://github.com/nodejitsu/node-http-proxy#listening-for-proxy-events) and [configuration](https://github.com/nodejitsu/node-http-proxy#options) of [http-proxy](https://github.com/nodejitsu/node-http-proxy) \n- [`bodyParserJSON`](https://github.com/expressjs/body-parser/tree/56a2b73c26b2238bc3050ad90af9ab9c62f4eb97#bodyparserjsonoptions) JSON body parser\n- [`bodyParserText`](https://github.com/expressjs/body-parser/tree/56a2b73c26b2238bc3050ad90af9ab9c62f4eb97#bodyparsertextoptions) Text body parser\n- [`bodyParserRaw`](https://github.com/expressjs/body-parser/tree/56a2b73c26b2238bc3050ad90af9ab9c62f4eb97#bodyparserrawoptions) Raw body parser\n- [`bodyParserUrlencoded`](https://github.com/expressjs/body-parser/tree/56a2b73c26b2238bc3050ad90af9ab9c62f4eb97#bodyparserurlencodedoptions) URL-encoded form body parser\n- `bodyParserConf` => `{}` bodyParser settings. eg： `bodyParserConf : {'text/plain': 'text','text/html': 'text'}` will parsed `Content-Type='text/plain' and Content-Type='text/html'` with `bodyParser.text` \n- [`watchOptions`](https://github.com/paulmillr/chokidar#api) => `object` Options object as defined [chokidar api options](https://github.com/paulmillr/chokidar#api)\n- `header` => `{}` Access Control Allow options.\n ```js\n {\n header: {\n 'Access-Control-Allow-Methods': 'POST, GET, OPTIONS, PUT, DELETE',\n }\n }\n ```\n\n⚠️ No wildcard asterisk ~~`*`~~ - use parameters instead `(.*)`, support `v1.7.3+`\n\n⚠️ No wildcard asterisk ~~`(.*)`~~ - use parameters instead `*path`, support `v3.0.0+`\n\n## Delayed Response\n\nYou can use functional tool to enhance mock. [#17](https://github.com/jaywcjlove/webpack-api-mocker/issues/17)\n\n```js\nconst delay = require('mocker-api/delay');\nconst noProxy = process.env.NO_PROXY === 'true';\n\nconst proxy = {\n 'GET /api/user': {\n id: 1,\n username: 'kenny',\n sex: 6\n },\n // ...\n}\nmodule.exports = (noProxy ? {} : delay(proxy, 1000));\n```\n\n## apiMocker\n\n```js\napiMocker(app, mockerFilePath[, options])\napiMocker(app, Mocker[, options])\n```\n\nMulti entry `mocker` file watching\n\n```js\nconst apiMocker = require('mocker-api');\nconst mockerFile = ['./mock/index.js'];\n// or\n// const mockerFile = './mock/index.js';\napiMocker(app, mockerFile, options)\n```\n\n## Example\n\n### Using With Command\n\n[Base example](example/base)\n\n>⚠️ Not dependent on [webpack](https://github.com/webpack/webpack) and [webpack-dev-server](https://github.com/webpack/webpack-dev-server). \n\n```bash\n# Global install dependent.\nnpm install mocker-api -g\n# Run server\nmocker ./mocker/index.js\n```\n\nOr you can put it the `package.json` config as a current project dependency.\n\n```diff\n{\n \"name\": \"base-example\",\n \"scripts\": {\n+ \"api\": \"mocker ./mocker\"\n },\n \"devDependencies\": {\n+ \"mocker-api\": \"2.9.5\"\n },\n+ \"mocker\": {\n+ \"port\": 7788\n+ },\n \"license\": \"MIT\"\n}\n```\n\n### Using With [Express](https://github.com/expressjs/express)\n\n[Express example](https://github.com/jaywcjlove/mocker-api/tree/master/example/express)\n\nTo use api mocker on your [express](https://github.com/expressjs/express) projects.\n\n>⚠️ Not dependent on [webpack](https://github.com/webpack/webpack) and [webpack-dev-server](https://github.com/webpack/webpack-dev-server).\n\n```diff\nconst express = require('express');\n+ const path = require('path');\n+ const apiMocker = require('mocker-api');\n\nconst app = express();\n\n+ apiMocker(app, path.resolve('./mocker/index.js'))\napp.listen(8080);\n```\n\nor\n\n```diff\nconst express = require('express');\n+ const apiMocker = require('mocker-api');\n\nconst app = express();\n\n+ apiMocker(app, {\n+ 'GET /api/user': {\n+ id: 1,\n+ sex: 0\n+ }\n+ });\n\napp.listen(8080);\n```\n\n### Using With [Webpack](https://github.com/webpack/webpack)\n\n[webpack example](https://github.com/jaywcjlove/mocker-api/tree/master/example/webpack)\n\nTo use api mocker on your [Webpack](https://github.com/webpack/webpack) projects, simply add a setup options to your [webpack-dev-server](https://github.com/webpack/webpack-dev-server) options:\n\nChange your config file to tell the dev server where to look for files: `webpack.config.js`.\n\n```diff\nconst HtmlWebpackPlugin = require('html-webpack-plugin');\n+ const path = require('path');\n+ const apiMocker = require('mocker-api');\n\nmodule.exports = {\n entry: {\n app: './src/index.js',\n },\n output: {\n filename: '[name].bundle.js',\n path: path.resolve(__dirname, 'dist')\n },\n+ devServer: {\n+ ...\n+ before(app){\n+ apiMocker(app, path.resolve('./mocker/index.js'), {\n+ proxy: {\n+ '/repos/*path': 'https://api.github.com/',\n+ '/:owner/:repo/raw/:ref/*path': 'http://127.0.0.1:2018'\n+ },\n+ changeHost: true,\n+ })\n+ }\n+ },\n plugins: [\n new HtmlWebpackPlugin({\n template: path.resolve('./public/index.html'),\n title: 'Webpack App Mocker API'\n })\n ],\n};\n```\n\nMust have a file suffix! For example: `./mocker/index.js`.\n\nLet's add a script to easily run the dev server as well: `package.json`\n\n```diff\n{\n \"name\": \"development\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"main\": \"webpack.config.js\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\",\n+ \"start\": \"webpack serve --progress --mode development\",\n \"build\": \"webpack --mode production\"\n },\n \"keywords\": [],\n \"author\": \"\",\n \"license\": \"MIT\",\n \"devDependencies\": {\n \"html-webpack-plugin\": \"4.5.0\",\n \"mocker-api\": \"2.9.5\",\n \"webpack\": \"5.22.0\",\n \"webpack-cli\": \"4.5.0\",\n \"webpack-dev-server\": \"3.11.2\"\n }\n}\n```\n\nMock API proxying made simple.\n\n```diff\n{\n before(app){\n+ apiMocker(app, path.resolve('./mocker/index.js'), {\n+ proxy: {\n+ '/repos/*path': 'https://api.github.com/',\n+ },\n+ changeHost: true,\n+ })\n }\n}\n```\n\n### Using With create-react-app\n\n[create-react-app example](https://github.com/jaywcjlove/mocker-api/tree/master/example/create-react-app)\n\nTo use api mocker on your [create-react-app](https://github.com/facebook/create-react-app/blob/3f699fd08044de9ab0ce1991a66b376d3e1956a8/docusaurus/docs/proxying-api-requests-in-development.md) projects. create [`src/setupProxy.js`](https://github.com/jaywcjlove/mocker-api/blob/64a093685b05c70ab0ddcf3fd5dbede7871efa8a/example/create-react-app/src/setupProxy.js#L1-L11) and place the following contents in it:\n\n```diff\n+ const apiMocker = require('mocker-api');\n+ const path = require('path');\n\nmodule.exports = function(app) {\n+ apiMocker(app, path.resolve('./mocker/index.js'), {\n+ proxy: {\n+ '/repos/*path': 'https://api.github.com/',\n+ },\n+ changeHost: true,\n+ });\n};\n```\n\n```diff\n{\n .....\n \"devDependencies\": {\n+ \"mocker-api\": \"2.9.5\"\n },\n ....\n}\n```\n\n### Development\n\n```shell\n$ yarn install\n$ yarn run build\n$ yarn run watch\n$ yarn run test\n```\n\n## Contributors\n\nAs always, thanks to our amazing contributors!\n\n\n![](\"https://jaywcjlove.github.io/mocker-api/CONTRIBUTORS.svg\")
\n\n\nMade with [github-action-contributors](https://github.com/jaywcjlove/github-action-contributors).\n\n## License\n\n[MIT © Kenny Wong](https://github.com/jaywcjlove/mocker-api/blob/master/LICENSE)\n","readmeFilename":"README.md"}