@trojs/openapi-server 2.0.6 → 2.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@trojs/openapi-server",
     "description": "OpenAPI Server",
-    "version": "2.0.6",
+    "version": "2.1.0",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://trojs.org/"

package/src/express-callback.js

@@ -16,10 +16,11 @@ import { parseParams } from './params.js';
  * @param {boolean=} params.errorDetails
  * @param {Logger=} params.logger
  * @param {object=} params.meta
+ * @param {boolean=} params.mock
  * @returns {Function}
  */
 export const makeExpressCallback =
-    ({ controller, specification, errorDetails, logger, meta }) =>
+    ({ controller, specification, errorDetails, logger, meta, mock }) =>
     /**
      * Handle controller
      * @async
@@ -37,6 +38,7 @@ export const makeExpressCallback =
             const parameters = parseParams({
                 query: allParameters,
                 spec: context.operation.parameters,
+                mock,
             });
             const url = `${request.protocol}://${request.get('Host')}${request.originalUrl}`;
 

package/src/params.js

@@ -5,9 +5,10 @@ import { types } from './types.js';
  * @param {object} params
  * @param {object} params.query
  * @param {object} params.spec
+ * @param {boolean=} params.mock
  * @returns {object}
  */
-export const parseParams = ({ query, spec }) =>
+export const parseParams = ({ query, spec, mock = false }) =>
     spec
         .map((parameter) => {
             const { name, schema } = parameter;
@@ -19,8 +20,16 @@ export const parseParams = ({ query, spec }) =>
             const Type = types[type];
             const paramName = query?.[name];
 
+            if (!paramName && defaultValue !== undefined) {
+                return { name, value: defaultValue };
+            }
+
+            if (!paramName && mock && exampleValue !== undefined) {
+                return { name, value: exampleValue };
+            }
+
             if (!paramName) {
-                return { name, value: defaultValue ?? exampleValue };
+                return undefined;
             }
 
             if (Type === Boolean) {
@@ -33,6 +42,7 @@ export const parseParams = ({ query, spec }) =>
             const value = new Type(paramName).valueOf();
             return { name, value };
         })
+        .filter(Boolean)
         .reduce((acc, { name, value }) => {
             acc[name] = value;
             return acc;

package/src/router.js

@@ -25,6 +25,7 @@ import { unauthorized } from './handlers/unauthorized.js';
  * @param {object=} params.meta
  * @param {SecurityHandler[]=} params.securityHandlers
  * @param {AjvOpts=} params.ajvOptions
+ * @param {boolean=} params.mock
  * @returns {{ api: OpenAPIBackend<any>, openAPISpecification: object }}
  */
 export const setupRouter = ({
@@ -37,6 +38,7 @@ export const setupRouter = ({
     meta,
     securityHandlers = [],
     ajvOptions = {},
+    mock,
 }) => {
     const api = new OpenAPIBackend({
         definition: openAPISpecification,
@@ -69,16 +71,16 @@ export const setupRouter = ({
                     errorDetails,
                     logger,
                     meta,
+                    mock,
                 })
             );
         }
     );
 
     api.register('notImplemented', (context) => {
-        const { mock } = context.api.mockResponseForOperation(
-            context.operation.operationId
-        );
-        return mock;
+        const { mock: mockImplementation } =
+            context.api.mockResponseForOperation(context.operation.operationId);
+        return mockImplementation;
     });
 
     securityHandlers.forEach((securityHandler) => {