rest_api_faker 0.0.4 → 0.0.6-alpha
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -2
- package/bin/rest_api_faker.js +1 -1
- package/dist/cli.d.ts +2 -2
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +354 -1825
- package/dist/cli.js.map +1 -1
- package/dist/config.d.ts +20 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +133 -0
- package/dist/config.js.map +1 -0
- package/dist/database.d.ts +29 -0
- package/dist/database.d.ts.map +1 -0
- package/dist/database.js +216 -0
- package/dist/database.js.map +1 -0
- package/dist/index.d.ts +6 -7
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +9 -46
- package/dist/index.js.map +1 -1
- package/dist/loader.d.ts +4 -0
- package/dist/loader.d.ts.map +1 -0
- package/dist/loader.js +42 -0
- package/dist/loader.js.map +1 -0
- package/dist/logger.d.ts +14 -0
- package/dist/logger.d.ts.map +1 -0
- package/dist/logger.js +61 -0
- package/dist/logger.js.map +1 -0
- package/dist/query.d.ts +19 -0
- package/dist/query.d.ts.map +1 -0
- package/dist/query.js +289 -0
- package/dist/query.js.map +1 -0
- package/dist/relationships.d.ts +10 -0
- package/dist/relationships.d.ts.map +1 -0
- package/dist/relationships.js +95 -0
- package/dist/relationships.js.map +1 -0
- package/dist/rewriter.d.ts +5 -0
- package/dist/rewriter.d.ts.map +1 -0
- package/dist/rewriter.js +135 -0
- package/dist/rewriter.js.map +1 -0
- package/dist/router.d.ts +9 -0
- package/dist/router.d.ts.map +1 -0
- package/dist/router.js +275 -0
- package/dist/router.js.map +1 -0
- package/dist/server.d.ts +17 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +90 -0
- package/dist/server.js.map +1 -0
- package/dist/static.d.ts +8 -0
- package/dist/static.d.ts.map +1 -0
- package/dist/static.js +148 -0
- package/dist/static.js.map +1 -0
- package/package.json +13 -14
package/README.md
CHANGED
|
@@ -90,6 +90,8 @@ Or with watch mode to auto-reload on file changes:
|
|
|
90
90
|
rest_api_faker --watch db.json
|
|
91
91
|
```
|
|
92
92
|
|
|
93
|
+
**Note:** Watch mode monitors your data file, routes file, and middlewares file for changes and automatically reloads them.
|
|
94
|
+
|
|
93
95
|
**3. Access your API:**
|
|
94
96
|
|
|
95
97
|
```bash
|
|
@@ -116,7 +118,7 @@ Options:
|
|
|
116
118
|
-c, --config <path> Path to config file (default: "rest_api_faker.json")
|
|
117
119
|
-p, --port <number> Set port (default: 3000)
|
|
118
120
|
-H, --host <string> Set host (default: "localhost")
|
|
119
|
-
-w, --watch Watch
|
|
121
|
+
-w, --watch Watch data, routes, and middlewares files for changes
|
|
120
122
|
-r, --routes <path> Path to routes file (URL rewrite rules)
|
|
121
123
|
-m, --middlewares <path> Path to middleware file
|
|
122
124
|
-s, --static <path> Set static files directory (default: "./public")
|
|
@@ -129,15 +131,23 @@ Options:
|
|
|
129
131
|
-i, --id <field> Set database id property (default: "id")
|
|
130
132
|
--fks <suffix> Set foreign key suffix (default: "Id")
|
|
131
133
|
-q, --quiet Suppress log messages
|
|
134
|
+
-l, --log-level <level> Set log level: trace | debug | info (default: "info")
|
|
132
135
|
-h, --help Show help
|
|
133
136
|
-v, --version Show version number
|
|
134
137
|
|
|
138
|
+
Log Levels:
|
|
139
|
+
trace Show all logs including trace messages (most verbose)
|
|
140
|
+
debug Show debug and info logs (hide trace)
|
|
141
|
+
info Show only info logs (default, least verbose)
|
|
142
|
+
|
|
135
143
|
Examples:
|
|
136
144
|
rest_api_faker db.json Start with db.json
|
|
137
145
|
rest_api_faker --watch db.json Start with auto-reload
|
|
138
146
|
rest_api_faker --port 4000 db.json Start on port 4000
|
|
139
147
|
rest_api_faker file.js Use a JavaScript file
|
|
140
148
|
rest_api_faker --routes routes.json Use custom routes
|
|
149
|
+
rest_api_faker --log-level debug db.json Show debug logs
|
|
150
|
+
rest_api_faker --log-level trace db.json Show all logs including trace
|
|
141
151
|
```
|
|
142
152
|
|
|
143
153
|
### Routes
|
|
@@ -317,10 +327,28 @@ You can use a configuration file instead of CLI options. Create an `rest_api_fak
|
|
|
317
327
|
"delay": 0,
|
|
318
328
|
"id": "id",
|
|
319
329
|
"foreignKeySuffix": "Id",
|
|
320
|
-
"quiet": false
|
|
330
|
+
"quiet": false,
|
|
331
|
+
"logLevel": "info"
|
|
321
332
|
}
|
|
322
333
|
```
|
|
323
334
|
|
|
335
|
+
**Configuration Options:**
|
|
336
|
+
|
|
337
|
+
- `port` - Server port (default: 3000)
|
|
338
|
+
- `host` - Server host (default: "localhost")
|
|
339
|
+
- `watch` - Watch for file changes (default: false)
|
|
340
|
+
- `routes` - Path to routes file for URL rewriting
|
|
341
|
+
- `middlewares` - Path to custom middleware file
|
|
342
|
+
- `static` - Static files directory (default: "./public")
|
|
343
|
+
- `readOnly` - Allow only GET requests (default: false)
|
|
344
|
+
- `noCors` - Disable CORS (default: false)
|
|
345
|
+
- `noGzip` - Disable GZIP compression (default: false)
|
|
346
|
+
- `delay` - Add delay to responses in milliseconds
|
|
347
|
+
- `id` - Database ID field name (default: "id")
|
|
348
|
+
- `foreignKeySuffix` - Foreign key suffix (default: "Id")
|
|
349
|
+
- `quiet` - Suppress log messages (default: false)
|
|
350
|
+
- `logLevel` - Log level: "trace" | "debug" | "info" (default: "info")
|
|
351
|
+
|
|
324
352
|
Then simply run:
|
|
325
353
|
|
|
326
354
|
```bash
|
package/bin/rest_api_faker.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
|
|
2
|
+
import('../dist/cli.js');
|
package/dist/cli.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
export {};
|
|
2
|
+
//# sourceMappingURL=cli.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}
|