@trojs/openapi-server 1.11.2 → 1.13.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@trojs/openapi-server",
     "description": "OpenAPI Server",
-    "version": "1.11.2",
+    "version": "1.13.0",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://trojs.org/"
@@ -35,7 +35,7 @@
     "main": "src/server.js",
     "devDependencies": {
         "@eslint/js": "^9.15.0",
-        "@trojs/lint": "^0.2.9",
+        "@trojs/lint": "^0.3.4",
         "@types/node": "^22.0.0",
         "@types/express-serve-static-core": "^5.0.6",
         "eslint": "^9.15.0",

package/src/api.js

@@ -93,10 +93,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({

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)
@@ -9,6 +9,15 @@ export const responseValidation = (context, request, response) => {
     context.operation
   )
   if (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'
 
 /**
@@ -66,7 +66,7 @@ export const setupRouter = ({
     unauthorizedHandler: unauthorizedHandler || unauthorized,
     validationFail: requestValidation,
     notFound,
-    postResponseHandler: responseValidation
+    postResponseHandler: makeResponseValidation(logger)
   })
 
   operationIds({ specification: openAPISpecification }).forEach(