feat(openapi-v3): export a constant for the default openapi spec info

Signed-off-by: Raymond Feng <enjoyjava@gmail.com>
loopbackio · Sep 14, 2020 · fce91a2 · fce91a2
1 parent 9fe798f
commit fce91a2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/packages/openapi-v3/src/enhancers/spec-enhancer.service.ts b/packages/openapi-v3/src/enhancers/spec-enhancer.service.ts
@@ -7,7 +7,11 @@ import {config, extensionPoint, extensions, Getter} from '@loopback/core';
 import debugModule from 'debug';
 import * as _ from 'lodash';
 import {inspect} from 'util';
-import {OpenApiSpec, SecuritySchemeObject} from '../types';
+import {
+  DEFAULT_OPENAPI_SPEC_INFO,
+  OpenApiSpec,
+  SecuritySchemeObject,
+} from '../types';
 import {OASEnhancerBindings} from './keys';
 import {OASEnhancer} from './types';
 const jsonmergepatch = require('json-merge-patch');
@@ -48,8 +52,7 @@ export class OASEnhancerService {
   private _spec: OpenApiSpec = {
     openapi: '3.0.0',
     info: {
-      title: 'LoopBack Application',
-      version: '1.0.0',
+      ...DEFAULT_OPENAPI_SPEC_INFO,
     },
     paths: {},
   };

diff --git a/packages/openapi-v3/src/types.ts b/packages/openapi-v3/src/types.ts
@@ -18,6 +18,11 @@ export type OpenApiSpec = OpenAPIObject;
 // Export also all spec interfaces
 export * from 'openapi3-ts';
 
+export const DEFAULT_OPENAPI_SPEC_INFO = {
+  title: 'LoopBack Application',
+  version: '1.0.0',
+};
+
 /**
  * Create an empty OpenApiSpec object that's still a valid openapi document.
  *
@@ -27,8 +32,7 @@ export function createEmptyApiSpec(): OpenApiSpec {
   return {
     openapi: '3.0.0',
     info: {
-      title: 'LoopBack Application',
-      version: '1.0.0',
+      ...DEFAULT_OPENAPI_SPEC_INFO,
     },
     paths: {},
     servers: [{url: '/'}],