添加 Knex 驱动和 PostgreSQL 依赖，更新元数据获取端点的 OpenAPI 规范

Author: hotlong

examples/apps/nestjs/package.json

@@ -14,6 +14,8 @@
     "@nestjs/platform-express": "^10.0.0",
     "@objectql/core": "*",
     "@objectql/driver-mongo": "*",
+    "@objectql/driver-knex": "*",
+    "pg": "^8.11.3",
     "@objectql/api": "*",
     "@example/project-management": "*",
     "reflect-metadata": "^0.1.13",

examples/apps/nestjs/src/objectql/objectql.instance.ts

@@ -1,11 +1,11 @@
 import { ObjectQL } from '@objectql/core';
-import { MongoDriver } from '@objectql/driver-mongo';
+import { KnexDriver } from '@objectql/driver-knex';
 
 export const objectql = new ObjectQL({
   datasources: {
-      default: new MongoDriver({ 
-          url: process.env.MONGO_URL || 'mongodb://127.0.0.1:27017/objectql_example',
-          dbName: 'objectql_example'
+      default: new KnexDriver({ 
+          client: 'pg',
+          connection: process.env.DATABASE_URL || 'postgres://postgres:postgres@localhost:5432/objectql_example'
       })
   },
   packages: [

packages/api/src/index.ts

@@ -143,6 +143,19 @@ export function createObjectQLRouter(options: ObjectQLServerOptions): Router {
         }
     });
 
+    router.get('/_schema/:type/:id', async (req: Request, res: Response) => {
+        try {
+            const { type, id } = req.params;
+            const item = objectql.metadata.get(type, id);
+            if (!item) {
+                return res.status(404).json({ error: "Metadata not found" });
+            }
+            res.json(item);
+        } catch (e: any) {
+             res.status(500).json({ error: e.message });
+        }
+    });
+
     // NONE for now, as :objectName is the root.
     // However, we might want /:objectName/count or /:objectName/aggregate.
 

packages/api/src/swagger/generator.ts

@@ -63,6 +63,42 @@ export function generateOpenApiSpec(objectql: IObjectQL) {
       }
   };
 
+  paths['/api/_schema/{type}/{id}'] = {
+      get: {
+          summary: "Get Single Metadata",
+          tags: ["System"],
+          parameters: [
+              {
+                  name: "type",
+                  in: "path",
+                  required: true,
+                  schema: { type: "string" },
+                  description: "Metadata type"
+              },
+              {
+                  name: "id",
+                  in: "path",
+                  required: true,
+                  schema: { type: "string" },
+                  description: "Metadata ID"
+              }
+          ],
+          responses: {
+              200: {
+                  description: "Metadata content",
+                  content: {
+                      'application/json': {
+                          schema: { type: 'object' }
+                      }
+                  }
+              },
+              404: {
+                  description: "Metadata not found"
+              }
+          }
+      }
+  };
+
   Object.values(configs).forEach((config) => {
     const objectName = config.name;
     const schemaName = objectName;

packages/metadata/src/plugins/objectql.ts

@@ -142,30 +142,31 @@ export function registerObjectQLPlugins(loader: MetadataLoader) {
     });
 
     // Data
-    loader.use({
-        name: 'data',
-        glob: ['**/*.data.yml', '**/*.data.yaml'],
-        handler: (ctx) => {
-            try {
-                const content = ctx.content;
-                const data = yaml.load(content);
-                if (!Array.isArray(data)) return;
+    // loader.use({
+    //     name: 'data',
+    //     glob: ['**/*.data.yml', '**/*.data.yaml'],
+    //     handler: (ctx) => {
+    //         try {
+    //             const content = ctx.content;
+    //             const data = yaml.load(content);
+    //             if (!Array.isArray(data)) return;
 
-                const basename = path.basename(ctx.file);
-                const objectName = basename.replace(/\.data\.ya?ml$/, '');
+    //             const basename = path.basename(ctx.file);
+    //             const objectName = basename.replace(/\.data\.ya?ml$/, '');
 
-                const entry = ctx.registry.getEntry('object', objectName);
-                if (entry) {
-                    const config = entry.content as ObjectConfig;
-                    config.data = data;
-                } else {
-                    console.warn(`Found data for unknown object '${objectName}' in ${ctx.file}`);
-                }
-            } catch (e) {
-                console.error(`Error loading data from ${ctx.file}:`, e);
-            }
-        }
-    });
+    //             const entry = ctx.registry.getEntry('object', objectName);
+    //             if (entry) {
+    //                 const config = entry.content as ObjectConfig;
+    //                 // We don't want to load data into metadata
+    //                 // config.data = data; 
+    //             } else {
+    //                 // console.warn(`Found data for unknown object '${objectName}' in ${ctx.file}`);
+    //             }
+    //         } catch (e) {
+    //             console.error(`Error loading data from ${ctx.file}:`, e);
+    //         }
+    //     }
+    // });
 }
 
 function registerObject(registry: any, obj: any, file: string, packageName?: string) {