@trojs/openapi-server 1.12.1 → 1.13.1

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@trojs/openapi-server",
     "description": "OpenAPI Server",
-    "version": "1.12.1",
+    "version": "1.13.1",
     "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

@@ -1,5 +1,6 @@
 import express from 'express'
 import swaggerUi from 'swagger-ui-express'
+import crypto from 'node:crypto'
 import { setupRouter } from './router.js'
 
 /**
@@ -93,10 +94,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 = `"${crypto.createHash('sha256').update(apiDocsString).digest('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({