@get-enlace/express 0.0.2 → 0.0.4

package/README.md

@@ -22,6 +22,33 @@ app.use('/enlace', enlace({ spec: './openapi.json' }));
 `spec` is a file path, a URL, or an already-parsed OpenAPI 3.x object — whatever's easiest to
 point at your API's own document.
 
+## Using an existing spec setup
+
+Already generating your OpenAPI document with [`swagger-jsdoc`](https://www.npmjs.com/package/swagger-jsdoc)?
+Call it yourself and pass the result straight through as `spec` — no separate export step:
+
+```ts
+import express from 'express';
+import swaggerJsdoc from 'swagger-jsdoc';
+import { enlace } from '@get-enlace/express';
+
+const spec = swaggerJsdoc({
+  definition: {
+    openapi: '3.0.3',
+    info: { title: 'My API', version: '1.0.0' },
+    servers: [{ url: 'http://localhost:4000' }], // Enlace sends requests here
+  },
+  apis: ['./routes/*.js'],
+});
+
+app.use('/enlace', enlace({ spec }));
+```
+
+`swaggerJsdoc()` runs synchronously with no server instance required, so this works before
+`app.listen()`. Already mounting `swagger-ui-express` from the same document? Handing that same
+object to `enlace()` too doesn't change how that keeps working — they're independent consumers of
+the same spec.
+
 ## Learn more
 
 See the [`enlace-js` repo](https://github.com/get-enlace/enlace-js) for the other adapters in

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@get-enlace/express",
   "private": false,
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Simple Express adapter for @get-enlace/ui. Early dev preview: no persistence yet (serves the spec + UI bundle only), install via the `dev` dist-tag on GitHub Packages.",
   "license": "MIT",
   "repository": {
@@ -33,7 +33,7 @@
     "express": "^4.17.0 || ^5.0.0"
   },
   "dependencies": {
-    "@get-enlace/ui": "0.0.2",
+    "@get-enlace/ui": "0.0.4",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {