docs(config): document openAPI.production option (#2940)

nitrojs · Dec 19, 2024 · 1767019 · 1767019
1 parent 26726be
commit 1767019
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/3.config/0.index.md b/docs/3.config/0.index.md
@@ -64,6 +64,16 @@ openAPI: {
 }
 ```
 
+Theses routes are disabled by default in production. To enable them, use the `production` key.
+`"runtime"` allows middleware usage, and `"prerender"` is the most efficient because the JSON response is constant.
+
+```js
+openAPI: {
+    // IMPORTANT: make sure to protect OpenAPI routes if necessary!
+    production: "runtime", // or "prerender"
+}
+```
+
 If you like to customize the Scalar integration, you can [pass a configuration object](https://github.com/scalar/scalar) like this:
 
 ```js