Access to openapi metadata for req/resp lifecycle

[shubham941122]

Hi,

I would like to understand if OpenapiValidator middleware attaches any kind of openapi metadata (like operationId) to req/res object, to access them inside other middlewares. Below is my middlewares setup:

// Function to setup middleware and routes
async function setupMiddlewareAndRoutes() {
  // Middleware setup
  app.use(express.json());
  app.use(requestTrackingMiddleware);
  app.use(requestLogger); // Use the requestLogger middleware

  // Serve Swagger documentation
  const swaggerDocument = await $RefParser.dereference(path.join(__dirname, './api/openapi.yaml'));
  app.get('/docs/swagger.json', (req: express.Request, res: express.Response) => {
    res.json(swaggerDocument);
  });

  // Use the Swagger UI middleware to serve the Swagger docs
  app.use('/docs', swaggerUi.serveFiles(undefined, swaggerOptions), swaggerUi.setup(undefined, swaggerOptions));

  // API routes and validation middleware from express-openapi-validator
  app.use(openApiValidator);

  // Global error handler
  app.use((err: any, req: express.Request, res: express.Response, _next: express.NextFunction) => {
    logger.error('Global error handler', { error: err.message, stack: err.stack });
    err.status = err.status || 'error';
    err.statusCode = err.statusCode || err.status;

    res.status(err.statusCode).json({
      status: err.status,
      message: err.message,
    });
  });
}

OpenApiValidator Middleware

export const openApiValidator = OpenApiValidator.middleware({
  apiSpec: path.join(__dirname, '../api/openapi.yaml'),
  $refParser: {
    mode: 'dereference',
  },
  validateApiSpec: true,
  validateRequests: true,
  validateResponses: true,
  validateSecurity: {
    handlers: {
      basicAuth: validateBasicAuth,
    },
  },
  operationHandlers: {
    basePath: path.join(__dirname, '../controllers'),
    // Provide a function responsible for resolving an Express RequestHandler
    // function from the current OpenAPI Route object.
    resolver: resolvers.modulePathResolver,
  },
});