@trojs/openapi-server 3.1.4 → 3.3.0

package/package.json

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

package/src/api.js

@@ -26,6 +26,7 @@ import { setupRouter } from './router.js'
  * @property {boolean=} swagger
  * @property {boolean=} apiDocs
  * @property {AjvOpts=} ajvOptions
+ * @property {any[]=} middleware
  */
 
 /**
@@ -51,7 +52,8 @@ export class Api {
     securityHandlers,
     swagger,
     apiDocs,
-    ajvOptions
+    ajvOptions,
+    middleware = []
   }) {
     this.version = version
     this.specification = specification
@@ -65,6 +67,7 @@ export class Api {
     this.swagger = swagger ?? true
     this.apiDocs = apiDocs ?? true
     this.ajvOptions = ajvOptions ?? { allErrors: false }
+    this.middleware = middleware
   }
 
   setup () {
@@ -77,10 +80,26 @@ export class Api {
         swaggerUi.setup(this.specification)
       )
     }
+
     if (this.apiDocs) {
-      router.get('/api-docs', (_request, response) =>
+    // Generate an ETag for the specification (simple hash or JSON string)
+      const apiDocsString = JSON.stringify(this.specification)
+      const etag = `"${Buffer.from(apiDocsString).toString('base64')}"`
+
+      router.get('/api-docs', (request, response) => {
+        // Check for If-None-Match header
+        const ifNoneMatchHeader = request.headers['if-none-match']
+        if (ifNoneMatchHeader) {
+          const etags = ifNoneMatchHeader.split(',').map((tag) => tag.trim())
+          if (etags.includes('*') || etags.includes(etag)) {
+            response.status(304).end()
+            return
+          }
+        }
+        response.setHeader('Cache-Control', 'public, max-age=3600, must-revalidate')
+        response.setHeader('ETag', etag)
         response.json(this.specification)
-      )
+      })
     }
 
     const { api } = setupRouter({
@@ -96,6 +115,8 @@ export class Api {
     })
     api.init()
 
+    this.middleware.forEach((fn) => router.use(fn))
+
     router.use((request, response) =>
       api.handleRequest(request, request, response)
     )

package/src/handlers/response-validation.js

@@ -1,4 +1,4 @@
-export const responseValidation = (context, request, response) => {
+export default (logger) => (context, request, response) => {
   const responseDoesntNeedValidation = response.statusCode >= 400
   if (responseDoesntNeedValidation) {
     return response.json(context.response)
@@ -8,7 +8,16 @@ export const responseValidation = (context, request, response) => {
     context.response,
     context.operation
   )
-  if (valid?.errors) {
+  if (valid && valid.errors) {
+    if (logger) {
+      logger.error({
+        message: 'Response validation failed',
+        errors: valid.errors,
+        operation: context.operation,
+        statusCode: response.statusCode,
+        response: context.response
+      })
+    }
     return response.status(502).json({
       errors: valid.errors,
       status: 502,

package/src/router.js

@@ -4,7 +4,7 @@ import { makeExpressCallback } from './express-callback.js'
 import { operationIds } from './operation-ids.js'
 import { notFound } from './handlers/not-found.js'
 import { requestValidation } from './handlers/request-validation.js'
-import { responseValidation } from './handlers/response-validation.js'
+import makeResponseValidation from './handlers/response-validation.js'
 import { unauthorized } from './handlers/unauthorized.js'
 
 /**
@@ -43,23 +43,22 @@ export const setupRouter = ({
   customizeAjv,
   mock
 }) => {
-  const ajvWithExtraFormats = (originalAjv) => {
-    addFormats(originalAjv)
-    return originalAjv
-  }
   const api = new OpenAPIBackend({
     definition: openAPISpecification,
     apiRoot,
     strict: strictSpecification,
     ajvOpts: ajvOptions,
-    customizeAjv: customizeAjv || ajvWithExtraFormats
+    customizeAjv: (originalAjv) => {
+      addFormats(originalAjv)
+      return originalAjv
+    }
   })
 
   api.register({
     unauthorizedHandler: unauthorized,
     validationFail: requestValidation,
     notFound,
-    postResponseHandler: responseValidation
+    postResponseHandler: makeResponseValidation(logger)
   })
 
   operationIds({ specification: openAPISpecification }).forEach(