feat: experimental defineRouteMeta

examples/api-routes/api/test.get.ts

@@ -1 +1,14 @@
+import { defineOpenAPISchema } from "#internal/nitro/routes/openapi";
+
 export default defineEventHandler(() => "Test get handler");
+
+defineOpenAPISchema({
+    routeBase: '/api/test',
+    method: 'get',
+    schema: {
+        tags: ["Test"],
+        summary: "some test",
+        description: "some test description",
+        deprecated: false,
+    },
+});

examples/api-routes/api/test.post.ts

@@ -1 +1,28 @@
+import { defineOpenAPISchema } from "#internal/nitro/routes/openapi";
+
 export default defineEventHandler(() => "Test post handler");
+
+defineOpenAPISchema({
+    method: 'post',
+    routeBase: '/api/test',
+    schema: {
+        tags: [
+            "Test"
+        ],
+        parameters: [
+            {
+                in: "query",
+                name: 'test',
+                required: true
+            },
+        ],
+        responses: {
+            200: {
+                description: "OK"
+            },
+            404: {
+                description: "Not found"
+            },
+        },
+    },
+});

examples/api-routes/nitro.config.ts

@@ -1 +1,5 @@
-export default defineNitroConfig({});
+export default defineNitroConfig({
+    experimental: {
+        openAPI: true,
+    },
+});

src/runtime/routes/openapi.ts

@@ -6,12 +6,31 @@ import type {
   ParameterObject,
   PathsObject,
 } from "openapi-typescript";
+import { NitroOpenapiSchema } from "../../types";
 import { handlersMeta } from "#internal/nitro/virtual/server-handlers";
-import { useRuntimeConfig } from "#internal/nitro";
+import { useRuntimeConfig, useStorage } from "#internal/nitro";
 
 // Served as /_nitro/openapi.json
-export default eventHandler((event) => {
+export default eventHandler(async () => {
   const base = useRuntimeConfig()?.app?.baseURL;
+  const paths = getPaths();
+
+  for (const path in paths) {
+    const methods = Object.keys(paths[path]);
+    for (const method of methods) {
+      const hasItem = await useStorage(path).hasItem(`openapi-${method}`);
+      if (hasItem) {
+        const storage = await useStorage(path).getItem(`openapi-${method}`);
+        if (typeof storage === "object") {
+          const schema = storage as NitroOpenapiSchema;
+          paths[path][method] = {
+            ...paths[path][method],
+            ...schema.schema,
+          };
+        }
+      }
+    }
+  }
 
   return <OpenAPI3>{
     openapi: "3.0.0",
@@ -27,7 +46,7 @@ export default eventHandler((event) => {
       },
     ],
     schemes: ["http"],
-    paths: getPaths(),
+    paths,
   };
 });
 
@@ -96,3 +115,9 @@ function defaultTags(route: string) {
 
   return tags;
 }
+
+export function defineOpenAPISchema(schema: NitroOpenapiSchema) {
+  useStorage(schema.routeBase).setItem(`openapi-${schema.method}`, schema);
+
+  return schema;
+}

src/types/index.ts

@@ -6,3 +6,4 @@ export * from "./nitro";
 export * from "./handler";
 export * from "./utils";
 export * from "./module";
+export * from "./openapi";

src/types/openapi.ts

@@ -0,0 +1,8 @@
+import type { RouterMethod } from "h3";
+import type { OperationObject } from "openapi-typescript";
+
+export type NitroOpenapiSchema = {
+  routeBase: string;
+  method: RouterMethod;
+  schema: OperationObject;
+};