@techspikes/fastify-mock-fallback 1.0.0 → 1.0.2

package/README.md

@@ -53,7 +53,7 @@ await fastify.register(fastifyMockFallback, {
 await fastify.listen({ port: 3000 })
 ```
 
-Existing Fastify routes are not replaced. Register implemented routes before this plugin; if a generated mock route conflicts with an already registered route, the existing route wins. Registering an implemented route after a conflicting mock route causes Fastify to reject the duplicate route.
+Existing Fastify routes are not replaced when they use the same HTTP method and route structure as a generated mock. Register implemented routes before this plugin; for example, a generated `GET /pet/:petId` mock is skipped when either `GET /pet/:petId` or `GET /pet/:id` is already registered. Registering an implemented route after a conflicting mock route causes Fastify to reject the duplicate route.
 
 ### Options
 
@@ -149,6 +149,60 @@ paths:
                 missing:
                   x-request-match: missing
                   value: { code: 404, message: not found }
+    post:
+      operationId: updatePetWithForm
+      parameters:
+        - in: path
+          name: petId
+          required: true
+          schema: { type: integer }
+          examples:
+            update-doggie:
+              value: 10
+        - in: query
+          name: name
+          schema: { type: string }
+          examples:
+            update-doggie:
+              value: doggie
+        - in: query
+          name: status
+          schema: { type: string }
+          examples:
+            update-doggie:
+              value: sold
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              examples:
+                default:
+                  x-request-match: update-doggie
+                  value: { id: 10, name: doggie, status: sold }
+  /pet:
+    post:
+      operationId: addPet
+      requestBody:
+        description: Create a new pet
+        required: true
+        content:
+          application/json:
+            examples:
+              doggie:
+                value:
+                  id: 10
+                  name: doggie
+                  status: available
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              examples:
+                default:
+                  x-request-match: doggie
+                  value: { id: 10, name: doggie, status: available }
   /pets:
     get:
       operationId: listPets
@@ -165,6 +219,8 @@ In this example:
 * `GET /pet/1` uses a response example with `x-request-match`.
 * `GET /pet/2` uses same-name matching.
 * `GET /pet/3` uses a response example with `x-request-match` and returns `404`.
+* `POST /pet/10?name=doggie&status=sold` matches its path and query examples, then returns the response selected by `x-request-match`.
+* `POST /pet` with `Content-Type: application/json` and the `doggie` request body matches the request body example and returns its linked response.
 * `GET /pets` has no request examples, so it uses the status `200` response `example`.
 
 ## Validation

package/index.js

@@ -162,44 +162,48 @@ function collectRequestExamples (pathItem, operation, operationName) {
     const source = RequestMatcher.sources[param.in]
 
     // Parameters without examples do not contribute matching conditions.
-    Object.entries(param.examples ?? {}).forEach(([exampleName, example]) => {
-      rejectInvalidRequestMatchLocation(example, operationName)
+    Object.entries(param.examples ?? {})
+      .filter(([, example]) => example.externalValue === undefined)
+      .forEach(([exampleName, example]) => {
+        rejectInvalidRequestMatchLocation(example, operationName)
 
-      const requestExampleVariants = requestExamples.get(exampleName) ?? [[]]
+        const requestExampleVariants = requestExamples.get(exampleName) ?? [[]]
 
-      requestExampleVariants.forEach(conditions => {
-        conditions.push({ source, name: param.name, value: example.value })
-      })
+        requestExampleVariants.forEach(conditions => {
+          conditions.push({ source, name: param.name, value: example.value })
+        })
 
-      requestExamples.set(exampleName, requestExampleVariants)
-    })
+        requestExamples.set(exampleName, requestExampleVariants)
+      })
   })
 
   // Request body examples add body conditions to matching request examples.
   Object.entries(operation.requestBody?.content ?? {}).forEach(([mediaType, media]) => {
     rejectInvalidRequestMatchLocation(media, operationName)
 
-    Object.entries(media.examples ?? {}).forEach(([exampleName, example]) => {
-      rejectInvalidRequestMatchLocation(example, operationName)
+    Object.entries(media.examples ?? {})
+      .filter(([, example]) => example.externalValue === undefined)
+      .forEach(([exampleName, example]) => {
+        rejectInvalidRequestMatchLocation(example, operationName)
 
-      const existingVariants = requestExamples.get(exampleName) ?? [[]]
+        const existingVariants = requestExamples.get(exampleName) ?? [[]]
 
-      // Body examples attach to the parameter-only variant for the same name.
-      const parameterConditions = existingVariants.find(conditions =>
-        conditions.every(condition => condition.source !== 'body')
-      ) ?? existingVariants[0].filter(condition => condition.source !== 'body')
+        // Body examples attach to the parameter-only variant for the same name.
+        const parameterConditions = existingVariants.find(conditions =>
+          conditions.every(condition => condition.source !== 'body')
+        ) ?? existingVariants[0].filter(condition => condition.source !== 'body')
 
-      // Preserve existing body variants while adding this media type variant.
-      const requestExampleVariants = [
-        ...existingVariants.filter(conditions => conditions.some(condition => condition.source === 'body')),
-        [
-          ...parameterConditions,
-          { source: 'body', mediaType, value: example.value },
-        ],
-      ]
+        // Preserve existing body variants while adding this media type variant.
+        const requestExampleVariants = [
+          ...existingVariants.filter(conditions => conditions.some(condition => condition.source === 'body')),
+          [
+            ...parameterConditions,
+            { source: 'body', mediaType, value: example.value },
+          ],
+        ]
 
-      requestExamples.set(exampleName, requestExampleVariants)
-    })
+        requestExamples.set(exampleName, requestExampleVariants)
+      })
   })
 
   return requestExamples

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@techspikes/fastify-mock-fallback",
-  "version": "1.0.0",
-  "description": "Fastify plugin that registers fallback mock routes from OpenAPI examples.",
+  "version": "1.0.2",
+  "description": "Fastify plugin that registers fallback mock routes from OpenAPI examples",
   "author": "knzbr <87257088+knzbr@users.noreply.github.com>",
   "license": "MIT",
   "type": "module",
@@ -19,7 +19,7 @@
     "fastify-plugin": "^5.1.0"
   },
   "peerDependencies": {
-    "fastify": "^5.8.5"
+    "fastify": "^5.0.0"
   },
   "devDependencies": {
     "@fastify/cookie": "^11.0.2",