apeframework 0.0.0-dev.15 → 0.0.0-dev.16

package/api/Api.d.ts

@@ -1,3 +1,4 @@
+import { OpenApiFormat } from './OpenApiFormat';
 import type { Endpoint } from './Endpoint';
 import type { ErrorHandler } from './ErrorHandler';
 import type { Format } from './Format';
@@ -27,6 +28,6 @@ declare class Api {
         onError?: ErrorHandler;
     });
     start(): Promise<string>;
-    openapi(): OpenAPIV3.Document;
+    openapi(format: OpenApiFormat): OpenAPIV3.Document;
 }
 export { Api, };

package/api/Api.js

@@ -8,6 +8,7 @@ const cors_1 = __importDefault(require("@fastify/cors"));
 const response_validation_1 = __importDefault(require("@fastify/response-validation"));
 const swagger_1 = __importDefault(require("@fastify/swagger"));
 const fastify_1 = __importDefault(require("fastify"));
+const OpenApiFormat_1 = require("./OpenApiFormat");
 const getAjv_1 = require("./getAjv");
 class Api {
     host;
@@ -76,8 +77,10 @@ class Api {
             port: this.port,
         });
     }
-    openapi() {
-        return this.server.swagger();
+    openapi(format) {
+        return this.server.swagger({
+            yaml: format === OpenApiFormat_1.OpenApiFormat.YAML,
+        });
     }
 }
 exports.Api = Api;

package/api/Api.ts

@@ -2,6 +2,7 @@ import cors from '@fastify/cors'
 import responseValidation from '@fastify/response-validation'
 import swagger from '@fastify/swagger'
 import fastify from 'fastify'
+import { OpenApiFormat } from './OpenApiFormat'
 import { getAjv } from './getAjv'
 import type { Endpoint } from './Endpoint'
 import type { ErrorHandler } from './ErrorHandler'
@@ -111,8 +112,10 @@ class Api {
     })
   }
 
-  public openapi(): OpenAPIV3.Document {
-    return this.server.swagger() as OpenAPIV3.Document
+  public openapi(format: OpenApiFormat): OpenAPIV3.Document {
+    return this.server.swagger({
+      yaml: format === OpenApiFormat.YAML,
+    }) as OpenAPIV3.Document
   }
 }
 

package/api/OpenApiFormat.d.ts

@@ -0,0 +1,5 @@
+declare enum OpenApiFormat {
+    JSON = "json",
+    YAML = "yaml"
+}
+export { OpenApiFormat, };

package/api/OpenApiFormat.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiFormat = void 0;
+var OpenApiFormat;
+(function (OpenApiFormat) {
+    OpenApiFormat["JSON"] = "json";
+    OpenApiFormat["YAML"] = "yaml";
+})(OpenApiFormat || (exports.OpenApiFormat = OpenApiFormat = {}));

package/api/OpenApiFormat.ts

@@ -0,0 +1,8 @@
+enum OpenApiFormat {
+  JSON = 'json',
+  YAML = 'yaml',
+}
+
+export {
+  OpenApiFormat,
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apeframework",
-  "version": "0.0.0-dev.15",
+  "version": "0.0.0-dev.16",
   "license": "MIT",
   "author": "Matthieu Symoens",
   "description": "Node.js app framework",