fix open api 3 generation

Author: Thiago Bustamante

README.MD

@@ -224,7 +224,7 @@ basePath | string | Base API path; e.g. the 'v1' in https://myapi.com/v1
 consumes | [string] | Default consumes property for the entire API
 description | string | API description; defaults to npm package description
 entryFile | string or string[] | The entry point to your API (it is possible to use glob patters)
-ouptupFormat | 'swagger_2' or 'openapi_3' | Inform if the generated spec will be in swagger 2.0 format or i open api 3.0
+ouptupFormat | 'Swagger_2' or 'OpenApi_3' | Inform if the generated spec will be in swagger 2.0 format or i open api 3.0
 host | string | The hostname to be informed in the generated swagger file
 license | string | API license number; defaults to npm package license
 name | string | API name; defaults to npm package name

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-rest-swagger",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Generate Swagger files from a typescript-rest project",
   "keywords": [
     "typescript",
@@ -96,4 +96,4 @@
     "node": ">=6.0.0"
   },
   "engineStrict": true
-}
+}

src/cli.ts

@@ -8,7 +8,7 @@ import * as _ from 'lodash';
 import { isAbsolute, join } from 'path';
 import * as ts from 'typescript';
 import * as YAML from 'yamljs';
-import { Config, SwaggerConfig } from './config';
+import { Config, Specification, SwaggerConfig } from './config';
 import { MetadataGenerator } from './metadata/metadataGenerator';
 import { SpecGenerator } from './swagger/generator';
 
@@ -98,7 +98,7 @@ function validateSwaggerConfig(conf: SwaggerConfig): SwaggerConfig {
     conf.description = conf.description || descriptionDefault;
     conf.license = conf.license || licenseDefault;
     conf.yaml = conf.yaml === false ? false : true;
-    conf.ouptupFormat = conf.ouptupFormat === 'openapi_3' ? conf.ouptupFormat : 'swagger_2';
+    conf.ouptupFormat = conf.ouptupFormat ? Specification[conf.ouptupFormat] : Specification.Swagger_2;
 
     return conf;
 }

src/config.ts

@@ -7,6 +7,11 @@ export interface Config {
     swagger: SwaggerConfig;
 }
 
+export enum Specification {
+    Swagger_2 = "Swagger_2",
+    OpenApi_3 = "OpenApi_3"
+}
+
 export interface SwaggerConfig {
     /**
      * Support the output to be an yaml file
@@ -26,7 +31,7 @@ export interface SwaggerConfig {
     /**
      * Inform if the generated spec will be in swagger 2.0 format or i open api 3.0
      */
-    ouptupFormat?: 'swagger_2' | 'openapi_3';
+    ouptupFormat?: Specification;
 
     /**
      * API host, expressTemplate.g. localhost:3000 or https://myapi.com

src/swagger/generator.ts

@@ -4,7 +4,7 @@ import * as _ from 'lodash';
 import * as mkdirp from 'mkdirp';
 import * as pathUtil from 'path';
 import * as YAML from 'yamljs';
-import { SwaggerConfig } from '../config';
+import { Specification, SwaggerConfig } from '../config';
 import {
     ArrayType, EnumerateType, Metadata, Method, ObjectType, Parameter,
     Property, ReferenceType, ResponseType, Type
@@ -21,7 +21,7 @@ export class SpecGenerator {
         this.debugger('Swagger Config: %j', this.config);
         this.debugger('Services Metadata: %j', this.metadata);
         let spec: any = this.getSwaggerSpec();
-        if (this.config.ouptupFormat === 'openapi_3') {
+        if (this.config.ouptupFormat === Specification.OpenApi_3) {
             spec = await this.convertToOpenApiSpec(spec);
         }
         return new Promise<void>((resolve, reject) => {