feat: quick rest api with moquerie.rest.ts

Author: Akryum

README.md

@@ -44,7 +44,7 @@ Install the `moquerie` package:
 pnpm install moquerie
 ```
 
-Create a `moquerie.config.ts` (or `moquerie.config.js`) file in the root of your project:
+*(Optional)* Create a `moquerie.config.ts` (or `moquerie.config.js`) file in the root of your project:
 
 ```ts
 import { defineConfig } from 'moquerie/config'
@@ -57,9 +57,31 @@ export default defineConfig({
 })
 ```
 
+## Getting started
+
+### REST Quickstart
+
+*(Optional)* To quickly create a fake REST server, create a `moquerie.rest.ts` file in your project that export resource types:
+
+```ts
+// moquerie.rest.ts
+
+export interface MyObject {
+  id: string
+  title: string
+  count: number
+}
+```
+
+Moquerie will detect this file and automatically create RESTful endpoints for each resource type found within (without any additional configuration).
+
+### GraphQL Quickstart
+
 If you have a GraphQL schema, you can let moquerie scan your code files for graphql schema definitions that uses the `gql` tag.
 
 ```ts
+// moquerie.config.ts
+
 import { defineConfig } from 'moquerie/config'
 
 export default defineConfig({
@@ -85,7 +107,7 @@ You also have several options to configure your GraphQL schema:
 
 For REST you don't need additional configuration, but your need to register API Routes.
 
-## Getting started
+### Run the server
 
 Run the `moquerie` command to start the server:
 

packages/core/src/config/resolve.ts

@@ -1,7 +1,13 @@
+import fs from 'node:fs'
+import path from 'pathe'
 import { loadConfig } from 'c12'
 import type { Config } from '../types/config.js'
 
 export async function resolveConfig(cwd: string) {
+  // Auto Rest API Types
+  const autoRestTypesFile = path.resolve(cwd, 'moquerie.rest.ts')
+  const autoRestTypesEnabled = fs.existsSync(autoRestTypesFile)
+
   return loadConfig<Config>({
     name: 'moquerie',
     cwd,
@@ -16,6 +22,13 @@ export async function resolveConfig(cwd: string) {
         '**/*.mock.js',
         '**/*.mock.ts',
       ],
+      ...autoRestTypesEnabled
+        ? {
+            rest: {
+              typeFiles: [autoRestTypesFile],
+            },
+          }
+        : {},
     },
   })
 }

playgrounds/quick-rest/.moquerie/types/queryManager.ts

@@ -0,0 +1,10 @@
+import { QueryManager } from "moquerie";
+import { Message, MyObject, User } from "./resources.js";
+
+declare module "moquerie" {
+    export interface QueryManagerProxy {
+        Message: QueryManager<Message>;
+        MyObject: QueryManager<MyObject>;
+        User: QueryManager<User>;
+    }
+}

playgrounds/quick-rest/.moquerie/types/resources.ts

@@ -0,0 +1,18 @@
+export interface Message {
+    id: string;
+    text: string;
+    user: User;
+}
+
+export interface MyObject {
+    id: string;
+    count: number;
+    title: string;
+}
+
+export interface User {
+    id: string;
+    email: string;
+    messages: Message;
+    name: string;
+}

playgrounds/quick-rest/moquerie.rest.ts

@@ -0,0 +1,18 @@
+export interface MyObject {
+  id: string
+  title: string
+  count: number
+}
+
+export interface User {
+  id: string
+  name: string
+  email: string
+  messages: Message[]
+}
+
+export interface Message {
+  id: string
+  text: string
+  user: User
+}

playgrounds/quick-rest/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "moquerie-playground-quick-rest",
+  "type": "module",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "moquerie": "moquerie"
+  },
+  "devDependencies": {
+    "moquerie": "workspace:*",
+    "typescript": "^5.2.2"
+  }
+}