@openapi-typescript-infra/service 4.0.0 → 4.1.0

package/build/types.d.ts

@@ -21,6 +21,10 @@ export interface ServiceLocals<Config extends ConfigurationSchema = Configuratio
     config: Config;
     meter: Meter;
     internalApp: Application<InternalLocals<this>>;
+    /**
+     * This is the parsed OpenAPI spec we are hosting (if openapi is enabled)
+     */
+    openApiSpecification?: ReturnType<typeof JSON.parse>;
 }
 export interface RequestLocals {
     rawBody?: Buffer | true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "An opinionated framework for building configuration driven services - web, api, or  ob. Uses OpenAPI, pino logging, express, confit, Typescript and vitest.",
   "main": "build/index.js",
   "scripts": {

package/src/express-app/app.ts

@@ -360,6 +360,12 @@ export async function listen<SLocals extends AnyServiceLocals = ServiceLocals<Co
             } else {
               locals.logger.info('No metrics will be exported');
             }
+            if (app.locals.openApiSpecification) {
+              locals.internalApp.get('/api-docs/openapi.json', (req, res) => {
+                res.json(app.locals.openApiSpecification);
+              });
+              locals.logger.info('OpenAPI specification available at /api-docs/openapi.json');
+            }
             accept();
           })
           .catch((error) => {

package/src/openapi.ts

@@ -2,6 +2,7 @@ import path from 'path';
 
 import _ from 'lodash';
 import * as OpenApiValidator from 'express-openapi-validator';
+import { OpenAPIFramework } from 'express-openapi-validator/dist/framework/index';
 import type { Handler } from 'express';
 
 import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from './types';
@@ -64,6 +65,12 @@ export async function openApi<
     {} as Record<string, Record<string, unknown>>,
   );
 
+  app.locals.openApiSpecification = await new OpenAPIFramework({ apiDoc: apiSpec })
+    .initialize({ visitApi() {} })
+    .catch((error) => {
+      app.locals.logger.error(error, 'Failed to parse and load OpenAPI spec');
+    });
+
   const defaultOptions: OAPIOpts = {
     apiSpec,
     ignoreUndocumented: true,

package/src/types.ts

@@ -28,6 +28,10 @@ export interface ServiceLocals<Config extends ConfigurationSchema = Configuratio
   config: Config;
   meter: Meter;
   internalApp: Application<InternalLocals<this>>;
+  /**
+   * This is the parsed OpenAPI spec we are hosting (if openapi is enabled)
+   */
+  openApiSpecification?: ReturnType<typeof JSON.parse>;
 }
 
 export interface RequestLocals {