feat: add UI endpoint configuration and schema support for REST server

Author: hotlong

packages/runtime/src/rest-server.ts

@@ -14,6 +14,7 @@ type NormalizedRestServerConfig = {
         apiPath: string | undefined;
         enableCrud: boolean;
         enableMetadata: boolean;
+        enableUi: boolean;
         enableBatch: boolean;
         enableDiscovery: boolean;
         documentation: RestApiConfig['documentation'];
@@ -120,6 +121,7 @@ export class RestServer {
                 apiPath: api.apiPath,
                 enableCrud: api.enableCrud ?? true,
                 enableMetadata: api.enableMetadata ?? true,
+                enableUi: api.enableUi ?? true,
                 enableBatch: api.enableBatch ?? true,
                 enableDiscovery: api.enableDiscovery ?? true,
                 documentation: api.documentation,
@@ -191,6 +193,11 @@ export class RestServer {
         if (this.config.api.enableMetadata) {
             this.registerMetadataEndpoints(basePath);
         }
+
+        // UI endpoints
+        if (this.config.api.enableUi) {
+            this.registerUiEndpoints(basePath);
+        }
 
         // CRUD endpoints
         if (this.config.api.enableCrud) {
@@ -227,6 +234,10 @@ export class RestServer {
                             discovery.endpoints.metadata = `${basePath}${this.config.metadata.prefix}`;
                         }
 
+                        if (this.config.api.enableUi) {
+                            discovery.endpoints.ui = `${basePath}/ui`;
+                        }
+
                         // Align auth endpoint with the versioned base path if present
                         if (discovery.endpoints.auth) {
                             discovery.endpoints.auth = `${basePath}/auth`;
@@ -381,6 +392,38 @@ export class RestServer {
             },
         });
     }
+
+    /**
+     * Register UI endpoints
+     */
+    private registerUiEndpoints(basePath: string): void {
+        const uiPath = `${basePath}/ui`;
+        
+        // GET /ui/view/:object/:type - Resolve view for object
+        this.routeManager.register({
+            method: 'GET',
+            path: `${uiPath}/view/:object/:type`,
+            handler: async (req: any, res: any) => {
+                try {
+                    if (this.protocol.getUiView) {
+                        const view = await this.protocol.getUiView({ 
+                            object: req.params.object, 
+                            type: req.params.type as any 
+                        });
+                        res.json(view);
+                    } else {
+                        res.status(501).json({ error: 'UI View resolution not supported by protocol implementation' });
+                    }
+                } catch (error: any) {
+                    res.status(404).json({ error: error.message });
+                }
+            },
+            metadata: {
+                summary: 'Resolve UI View for object',
+                tags: ['ui'],
+            },
+        });
+    }
 
     /**
      * Register CRUD endpoints for data operations

packages/spec/json-schema/api/ApiRoutes.json

@@ -12,6 +12,10 @@
           "type": "string",
           "description": "e.g. /api/meta"
         },
+        "ui": {
+          "type": "string",
+          "description": "e.g. /api/ui"
+        },
         "auth": {
           "type": "string",
           "description": "e.g. /api/auth"

packages/spec/json-schema/api/Discovery.json

@@ -29,6 +29,10 @@
               "type": "string",
               "description": "e.g. /api/meta"
             },
+            "ui": {
+              "type": "string",
+              "description": "e.g. /api/ui"
+            },
             "auth": {
               "type": "string",
               "description": "e.g. /api/auth"

packages/spec/json-schema/api/GetDiscoveryResponse.json

@@ -56,6 +56,10 @@
               "type": "string",
               "description": "e.g. /api/meta"
             },
+            "ui": {
+              "type": "string",
+              "description": "e.g. /api/ui"
+            },
             "auth": {
               "type": "string",
               "description": "e.g. /api/auth"

packages/spec/json-schema/api/RestApiConfig.json

@@ -29,6 +29,11 @@
           "default": true,
           "description": "Enable metadata API endpoints"
         },
+        "enableUi": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable UI API endpoints (Views, Menus, Layouts)"
+        },
         "enableBatch": {
           "type": "boolean",
           "default": true,

packages/spec/json-schema/api/RestServerConfig.json

@@ -32,6 +32,11 @@
               "default": true,
               "description": "Enable metadata API endpoints"
             },
+            "enableUi": {
+              "type": "boolean",
+              "default": true,
+              "description": "Enable UI API endpoints (Views, Menus, Layouts)"
+            },
             "enableBatch": {
               "type": "boolean",
               "default": true,

packages/spec/src/api/discovery.zod.ts

@@ -24,6 +24,9 @@ export const ApiRoutesSchema = z.object({
 
   /** Base URL for Schema Definitions (Metadata Protocol) */
   metadata: z.string().describe('e.g. /api/meta'),
+
+  /** Base URL for UI Configurations (Views, Menus) */
+  ui: z.string().optional().describe('e.g. /api/ui'),
 
   /** Base URL for Authentication */
   auth: z.string().describe('e.g. /api/auth'),

packages/spec/src/api/rest-server.zod.ts

@@ -67,6 +67,11 @@ export const RestApiConfigSchema = z.object({
    */
   enableMetadata: z.boolean().default(true).describe('Enable metadata API endpoints'),
 
+  /**
+   * Enable UI API endpoints
+   */
+  enableUi: z.boolean().default(true).describe('Enable UI API endpoints (Views, Menus, Layouts)'),
+  
   /**
    * Enable batch operation endpoints
    */