refactor: move swagger/openapi behind experimental flag

nitrojs · May 5, 2023 · 2079cab · 2079cab
1 parent f9c833c
commit 2079cab
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/docs/content/3.config.md b/docs/content/3.config.md
@@ -56,7 +56,19 @@ Server runtime configuration.
 
 - Default: `{}`
 
-Enable experimental features. Currently, none are available!
+Enable experimental features.
+
+#### `openAPI`
+
+Enable `/_nitro/swagger` and `/_nitro/openapi.json` endpoints.
+
+#### `wasm`
+
+Enable WASM support
+
+#### `legacyExternals`
+
+When enabled, lagacy (unstable) experimental rollup externals algorithm will be used.
 
 ### `storage`
 

diff --git a/src/options.ts b/src/options.ts
@@ -325,7 +325,7 @@ export async function loadOptions(
   options.plugins = options.plugins.map((p) => resolvePath(p, options));
 
   // Add open-api endpoint
-  if (options.dev) {
+  if (options.dev && options.experimental.openAPI) {
     options.handlers.push({
       route: "/_nitro/openapi.json",
       handler: "#internal/nitro/routes/openapi",

diff --git a/src/types/nitro.ts b/src/types/nitro.ts
@@ -202,6 +202,7 @@ export interface NitroOptions extends PresetOptions {
   experimental?: {
     wasm?: boolean | RollupWasmOptions;
     legacyExternals?: boolean;
+    openAPI?: boolean;
   };
   serverAssets: ServerAssetDir[];
   publicAssets: PublicAssetDir[];