{"id":20226214,"url":"https://github.com/steamerjs/steamer-plugin-mock","last_synced_at":"2025-03-03T12:47:08.966Z","repository":{"id":57370592,"uuid":"97719626","full_name":"steamerjs/steamer-plugin-mock","owner":"steamerjs","description":"The steamerjs plugin for mocking data in your project.","archived":false,"fork":false,"pushed_at":"2018-05-03T01:54:32.000Z","size":153,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-25T05:42:40.572Z","etag":null,"topics":[],"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/steamerjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2017-07-19T13:31:29.000Z","updated_at":"2018-05-03T01:54:33.000Z","dependencies_parsed_at":"2022-08-29T19:00:24.803Z","dependency_job_id":null,"html_url":"https://github.com/steamerjs/steamer-plugin-mock","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steamerjs%2Fsteamer-plugin-mock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steamerjs%2Fsteamer-plugin-mock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steamerjs%2Fsteamer-plugin-mock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steamerjs%2Fsteamer-plugin-mock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steamerjs","download_url":"https://codeload.github.com/steamerjs/steamer-plugin-mock/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241670132,"owners_count":20000326,"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":[],"created_at":"2024-11-14T07:16:48.467Z","updated_at":"2025-03-03T12:47:08.910Z","avatar_url":"https://github.com/steamerjs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# steamer-plugin-mock\n\n快速添加本地 mock 假数据命令。可以用于模拟后台接口进行测试。本项目的服务器是基于 [JSON-Server](https://github.com/typicode/json-server) 进行搭建。与服务器相关的路由、转发相关，可参考 [JSON-Server](https://github.com/typicode/json-server) 的文档。\n\n[![NPM Version](https://img.shields.io/npm/v/steamer-plugin-mock.svg?style=flat)](https://www.npmjs.com/package/steamer-plugin-mock)\n[![Travis](https://img.shields.io/travis/steamerjs/steamer-plugin-mock.svg)](https://travis-ci.org/steamerjs/steamer-plugin-mock)\n[![Deps](https://img.shields.io/david/steamerjs/steamer-plugin-mock.svg)](https://david-dm.org/steamerjs/steamer-plugin-mock)\n[![Coverage](https://img.shields.io/coveralls/steamerjs/steamer-plugin-mock.svg)](https://coveralls.io/github/steamerjs/steamer-plugin-mock)\n\n## 安装\n```javascript\nnpm i -g steamerjs\n\nnpm i -g steamer-plugin-mock\n```\n\n## 使用\n\n```javascript\nsteamer mock\n```\n\n此插件会为您在项目中自动生成 `mock` 目录并在此目录生成一个默认的 `db.js` 文件。然后运行 [JSON-Server](https://github.com/typicode/json-server) 在 `7000` 端口上。\n您之后可以修改`db.js`来完成您自己的mock需求。\n\n效果如图：\n![](http://pub.idqqimg.com/pc/misc/files/20170802/5c15a3282b594217b046a6d1b6966bd8.jpg)\n\n\n## 在 steamer 脚手架中使用\n如果你想在 [steamer 系列脚手架](https://steamerjs.github.io/docs/Starterkit.html)中使用，`steamer-plugin-mock` 的功能，可以设置 `config/steamer.config.js` 中 `\"api-port\": 7000` 的端口。此外，脚手架默认转发至 `/api/` 路径，因此 `steamer-plugin-mock` 需要配置 `--route` 参数，详细可参考后面相关的文档。\n\n\n\n## 路由说明\n[JSON-Server](https://github.com/typicode/json-server) 服务器根据传入的`Object`或者`JSON`文件的key作为API资源路径，值则作为返回的结果。\n[JSON-Server](https://github.com/typicode/json-server) 服务器完全支持`RESTful`的路由，如\n\n* 获取第一个用户\n```\nGET /users/1\n```\n\n* 分页\n```\nGET /users?_pages=7\n```\n\n* 筛选\n```\nGET /users?id=2\n```\n\n* 排序\n```\nGET /users?_sort=id\u0026_order=asc\n```\n\n## 参数说明\n### `--config`\n```javascript\nsteamer mock --config xxx.js/xxx.json\n```\n此插件会使用`--config`参数所指定的文件运行json-server。\n* 注意：如果使用js文件，您必须`export`一个Object对象。\n\n### `--port`\n```\nsteamer mock --port 8888\n```\n使用指定端口运行json-server\n\n### `--route`\n```\nsteamer mock --route route.json\n```\n使用指定自定义配置来自定URL，比如当您遇到一下场景\n\n1. 真正想访问的接口资源url是`api/xxx`，需要转发到[JSON-Server](https://github.com/typicode/json-server)\n2. 想通过`/posts/:category`的方式访问博客文章的不同类别\n\n您可以如下配置：\n* 示例文件\n```json\n{\n  \"/api/*\": \"/$1\",\n  \"/posts/:category\": \"/posts?category=:category\"\n}\n```\n效果如下\n```\n/api/posts # → /posts\n/api/posts/1  # → /posts/1\n/posts/javascript # → /posts?category=javascript\n```\n\n\n## 使用js生成假数据\n如果你想用强大的js快速生成一些假数据，可以借助下面两个推荐库的能力。\n\n* [Faker](https://github.com/marak/Faker.js/) 是用于快速生成假数据的库，包括常用的头像、邮箱、电话号码等信息，推荐使用。\n* [Mock](http://mockjs.com/) 同样是生成随机数据的库，并且能生成常用的随机汉字。\n\n下面以 `Faker` 作为例子，介绍如何生成用户列表数据：\n\n```javascript\nconst faker = require('faker');\nmodule.exports = () =\u003e {\n    let data = {\n        users: [],\n        foo: [],\n        bar: [],\n    };\n    // For more usage of faker.js, please visit http://marak.github.io/faker.js/\n    for(let id = 0; id \u003c 50; id++) {\n        data.users.push({\n            id: id,\n            firstName: faker.name.firstName(),\n            lastName: faker.name.lastName(),\n            email: faker.internet.email(),\n            phoneNumber: faker.phone.phoneNumber(),\n            avatar: faker.internet.avatar()\n        })\n    }\n    return data;\n}\n```\n\n以上js文件通过`steamer mock --config example.js`运行后，使用HTTP协议`GET localhost:6800/users`，即可获得50个随机生成的用户信息组成的数组：\n```javascript\n[\n  {\n    \"id\": 0,\n    \"firstName\": \"Micheal\",\n    \"lastName\": \"McKenzie\",\n    \"email\": \"Taya29@hotmail.com\",\n    \"phoneNumber\": \"837-316-7833\",\n    \"avatar\": \"https://s3.amazonaws.com/uifaces/faces/twitter/poormini/128.jpg\"\n  },\n  ...\n]\n```\n可以使用RESTful的语法操作数据：\n\n`GET localhost:6800/users/2` 获取第二个用户\n```javascript\n{\n  \"id\": 2,\n  \"firstName\": \"Devante\",\n  \"lastName\": \"Crooks\",\n  \"email\": \"Bonnie.Pouros82@gmail.com\",\n  \"phoneNumber\": \"(108) 724-7222 x5486\",\n  \"avatar\": \"https://s3.amazonaws.com/uifaces/faces/twitter/silv3rgvn/128.jpg\"\n}\n```\n`DELETE localhost:6800/users/3` 删除第三个用户\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteamerjs%2Fsteamer-plugin-mock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteamerjs%2Fsteamer-plugin-mock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteamerjs%2Fsteamer-plugin-mock/lists"}