feat(openapi): support configuration via openapi (#2299)

Co-authored-by: Pooya Parsa <[email protected]>

build.config.ts

@@ -24,5 +24,5 @@ export default defineBuildConfig({
  },
  },
  },
- externals: ["@nuxt/schema", "firebase-functions"],
+ externals: ["@nuxt/schema", "firebase-functions", "@scalar/api-reference"],
 });

docs/3.config/0.index.md

@@ -42,6 +42,35 @@ Enable experimental features.
 
 Enable `/_nitro/scalar` and `/_nitro/swagger` and `/_nitro/openapi.json` endpoints.
 
+- Default: `false`
+
+> [!IMPORTANT]
+> [Scalar](https://scalar.com/) support is currently available in [nightly channel](/guide/nightly).
+
+You can pass an object on the root level to modify your OpenAPI specification:
+
+```js
+openAPI: {
+ meta: {
+ title: 'My Awesome Project',
+ description: 'This might become the next big thing.',
+ version: '1.0'
+ }
+}
+```
+
+If you like to customize the Scalar integration, you can [pass a configuration object](https://github.com/scalar/scalar) like this:
+
+```js
+openAPI: {
+ ui: {
+ scalar: {
+ theme: 'purple'
+ }
+ }
+}
+```
+
 #### `wasm`
 
 Enable WASM support

package.json

@@ -135,6 +135,7 @@
  "devDependencies": {
  "@azure/functions": "^3.5.1",
  "@azure/static-web-apps-cli": "^1.1.7",
+ "@scalar/api-reference": "^1.20.7",
  "@cloudflare/workers-types": "^4.20240402.0",
  "@types/aws-lambda": "^8.10.136",
  "@types/bun": "^1.0.12",