feat: 新增动态路由

Author: winches

README.md

@@ -2,12 +2,16 @@
 
 约定式路由mock工具
 
-## ⭐️ feature
-✅ auto get mock route (自动获取mock路径)
+## ⭐️ Feature
+✅ Auto get mock route (自动获取mock路径)
 
 ✅ Hot Update 热更新支持（检测mock路径和配置文件）
 
-🤖 easy to get params（更简易的获取请求参数）
+✅ Dynamics routes 支持动态路由
+
+✅ Contractual routing 约定式路由（文件路径 -> 路由路径）
+
+🤖 Easy to get params（更简易的获取请求参数）
 
 ⚡ Faster response build with fastify（更快的响应速度）
 
@@ -21,7 +25,7 @@ pnpm add @winches/auto-mock -D
 ```
 
 ## Usage
-### add script
+### Add script
 ```json
 "scripts": {
   "mock": "auto-mock"
@@ -82,5 +86,28 @@ module.exports = function(req, query, body) {
   }
 }
 ```
+### Dynamics Routes（动态路由）
+#### For instance
+```
+└── your mockPath（__mock__）
+  │
+  └──  hello
+    │
+    └──  test:id.js
+```
+the http request will be transform `http://<host>:<port>/hello/test:id`
+
+and when send a request `http://<...>/hello/test/1`
+```js
+// hello/test:id.js
+module.exports = function(req, query, body) {
+  // response result
+  return {
+    code: 0,
+    msg: 'success',
+    res: req.params // { id: 1 }
+  }
+}
+```
 
-> note: **node require 14+**
+> note: **node require 14+**

__mock__/test/dynamics:id.js

@@ -0,0 +1,7 @@
+module.exports = function(req, query, body) {
+  return {
+    code: 0,
+    msg: '你号',
+    res: req.params
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@winches/auto-mock",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "约定式路由的mock工具",
   "main": "dist/app.js",
   "directories": {

routes/index.js

@@ -36,11 +36,20 @@ async function routes (fastify, options) {
 
   for (const item of mockList) {
     newItem = item.replace(/\\/g, '\/')
-    fastify.get(newItem, async (request, reply) => {
-      return require(join(mockDir, `${item}.js`))(request, request.query, request.body)
+    // 判断是否为动态路径
+    if (newItem.includes(':')) {
+      const path = newItem.replace(':', '/:')
+      return addRoutes(path, item)
+    }
+    addRoutes(newItem, item)
+  }
+
+  function addRoutes(url, name) {
+    fastify.get(url, async (request, reply) => {
+      return require(join(mockDir, `${name}.js`))(request, request.query, request.body)
     })
-    fastify.post(newItem, async (request, reply) => {
-      return require(join(mockDir, `${item}.js`))(request, request.query, request.body)
+    fastify.post(url, async (request, reply) => {
+      return require(join(mockDir, `${name}.js`))(request, request.query, request.body)
     })
   }
 }